If you plan on contributing to this project, you will need to use git in some way to clone the project. Otherwise, simply selecting to download the repo will do.
Various git programs, such as [GitHub Desktop](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-a-repository-from-github-to-github-desktop), [GitKraken](https://support.gitkraken.com/working-with-repositories/open-clone-init/), and [git for Windows](https://gitforwindows.org/) are available to clone the repository with git. Each of these provide different levels of features and different levels of complexity.
To build this project, you will need Python, a compiler for the C code that Cython generates, and several python libraries that will be installed with pip.
If you do not already have pip installed (it should be installed with python if you have an up to date version), follow the instructions on the [pip website](https://pip.pypa.io/en/stable/installing/) to install it.
A compiler must then be installed. According to [the cython documentation](https://cython.readthedocs.io/en/latest/src/quickstart/install.html), you can use either [MinGW](https://osdn.net/projects/mingw/releases/) or Microsoft Visual C.
If you choose to use MinGW, follow the instructions in the [cython documentation](https://cython.readthedocs.io/en/latest/src/tutorial/appendix.html) to get it set up.
Using command prompt, install the pip packages [cython](https://pypi.org/project/Cython/), [numpy](https://pypi.org/project/numpy/), and [matplotlib](https://pypi.org/project/matplotlib/), as well as [setuptools](https://pypi.org/project/setuptools/), if for some reason it is not already installed.
The syntax to install a package with pip is
```
pip install PACKAGE
```
Where `PACKAGE` is replaced with the name of the package.
### 4. Using Cython, compile `claude_low_level_library` and `claude_top_level_library`
Simply open command prompt, navigate to directory containing this file, and run:
```
python claude_setup.py build_ext --inplace
```
This will convert the `.pyx` files in the repository to C files, then compile them.
If you're using apt as your package manager, these correspond to the packages `git``python3``python3-setuptools``cython3``python3-numpy``python3-matplotlib`.
If using a GUI front-end for git, your method of doing it may vary.
### 2. Using Cython, compile `claude_low_level_library` and `claude_top_level_library`
In your terminal, in the base `claude` directory, simply run
```
python3 claude_setup.py build_ext --inplace
```
This will convert the `.pyx` files in the repository to C files, then compile them.
### 3. Run the model
In your terminal, run
```
python3 ./toy_model.py
```
#### 2.1 Troubleshooting
For one reason or another, step 2 may fail. Here are some errors you might run in to:
##### Python.h: no such file or directory
This means that you did not install the equivalent of apt's `python3-dev` package - you only have python for running programs, but lack the necessary headers for developing with it. If you are using apt and install the packages listed above, this should not occur.
##### some_other_file.h: no such file or directory
This likely means that the compiler building the libraries is not being told to search the proper directories for header files to include.
One such case where this can happen is when you have libxcrypt installed, so Python.h includes `<crypt.h>`, but setuptools does not tell the compiler where to search for that.
You need to find where the crypt.h header is to tell setuptools where to include it, so you can use the aptly named `find`.
You can use `find` in the format `find dir/ -name "pattern"` to recursively search directories from `dir/` and get the full path of the header file you are searching for.
If the #include has a directory included (e.g. `#include <blah/foo.h>`), use the directory which contains that directory (if `foo.h` is in `/usr/include/alice/blah/foo.h`, you want `/usr/include/alice`).
Separate multiple includes with `:`, so including `/usr/include/foo` and `/usr/include/bar`, you do `-I/usr/include/foo:/usr/include/bar`.
However, when you manually specify what directories to include, it will not automatically include numpy, so you will need to specify that too. You can wait until it gives you an error about that to find what you need to include.
If you plan on contributing to this project, you will need to use git in some way to clone the project. Otherwise, simply selecting to download the repo will do.
Various git programs, such as [GitHub Desktop](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-a-repository-from-github-to-github-desktop), [GitKraken](https://support.gitkraken.com/working-with-repositories/open-clone-init/), or just git are available to clone the repository. Each of these provide different levels of features and different levels of complexity.
git can be installed through homebrew using `brew install git`.
Using git, you can clone the repository via https with this command:
