move to a more standard directory structure

README.md

@@ -60,13 +60,12 @@ jupyter lab
 ├── CITATION.cff # This file describes how to cite the work contained in this repository.
 ├── LICENSE # Outlines what legal rights you have to use this software.
 ├── README.md # You are here!
-├── code
+├── README.md # Human readable information about the little python package in here
-│   ├── README.md # Human readable information about the little python package in here
+├── pyproject.toml # Machine readable information about that same package
-│   ├── pyproject.toml # Machine readable information about that same package
+├── setup.cfg # Tells Pip how to install this package
-│   ├── setup.cfg # Tells Pip how to install this package
+├── src
-│   ├── src
+|   └── MCFF # The actual code lives in here!
-│   │   └── MCFF # The actual code lives in here!
+└─ tests # automated tests for the code
-│   └── tests # automated tests for the code
 └── learning # Supporting documentation
 ```
 

readthedocs.yaml

@@ -13,7 +13,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: code/docs/conf.py
+   configuration: docs/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
@@ -23,6 +23,6 @@ sphinx:
 python:
    install:
    - requirements: requirements.txt
-   - requirements: code/docs/requirements.txt
+   - requirements: docs/requirements.txt
    - method: pip
-     path: code/
+     path: .

tests/test_energy.py

@@ -10,7 +10,9 @@ all_up = np.ones([100, 100])
 all_down = -np.ones([100, 100])
 random = np.random.choice([-1, 1], size=(100, 100))
 custom = (
-    1 - 2 * imread(Path(__file__).parents[2] / "learning/data/test_state.png")[:, :, 0]
+    1
+    - 2
+    * imread(Path(__file__).parents[1] / "docs/learning/data/test_state.png")[:, :, 0]
 )  # load a 100x100 png, take the red channel, remap 0,1 to -1,1
 
 states = [all_up, all_down, random, custom]