Upload crawl.py

crawl.py

@@ -0,0 +1,77 @@
+import os
+import csv
+import json
+
+def read(filename):
+    """Read the contents of a file."""
+    with open(filename, 'r') as f:
+        return f.read()
+    
+def read_ipynb(filename):
+    cells = json.loads(read(filename))["cells"]
+
+    text = ""
+
+    for i, cell in enumerate(cells):
+        if cell['cell_type'] == "markdown":
+            if i == 0:
+                text += f"{''.join(cell['source'])}\n"
+            else:
+                text += f"\n{''.join(cell['source'])}\n"
+        elif cell['cell_type'] == "code":
+            text += f"\n```\n{''.join(cell['source'])}\n```"
+            
+    return text
+
+def read_files(base):
+    """Collect text and corresponding source paths from files in a directory."""
+    text = []
+    source = []
+    
+    home = "./docs/index.rst"
+    installation = f"{base}/installation"
+    fundamentals = f"{base}/fundamentals"
+    notebooks = f"./docs/source/examples/notebooks/getting_started"
+    
+    text.append(read(home))
+    source.append(f"PyBaMM/{home[2:]}")
+    
+    for file in os.listdir(base):
+        if file == "getting_started.md":
+            text.append(read(f"{base}/{file}"))
+            source.append(f"PyBaMM/{base[2:]}/{file}")
+        
+    for file in os.listdir(installation):
+        if file.endswith(".rst"):
+            text.append(read(f"{installation}/{file}"))
+            source.append(f"PyBaMM/{installation[2:]}/{file}")
+            
+    for file in os.listdir(fundamentals):
+        if file.endswith(".md"):
+            text.append(read(f"{fundamentals}/{file}"))
+            source.append(f"PyBaMM/{fundamentals[2:]}/{file}")
+            
+    for file in os.listdir(notebooks):
+        if file.endswith(".ipynb"):
+            text.append(read_ipynb(f"{notebooks}/{file}"))
+            source.append(f"PyBaMM/{notebooks[2:]}/{file}")
+            
+    return text, source
+
+
+def write_to_csv(text, source, output_file="dataset.csv"):
+    """Write text and source paths to a CSV file."""
+    with open(output_file, mode='w') as dataset:
+        dataset = csv.writer(dataset, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL)
+        dataset.writerow(['text', 'source'])
+        for text, source in zip(text, source):
+            dataset.writerow([text, source])
+
+
+def main():
+    base = "./docs/source/user_guide"
+    text, source = read_files(base)
+    write_to_csv(text, source)
+
+if __name__ == "__main__":
+    main()