Skip to content
Snippets Groups Projects
Commit fa1f8bf2 authored by dh00601's avatar dh00601
Browse files

updated readme

parent 1fcc9283
No related branches found
No related tags found
No related merge requests found
......@@ -99,15 +99,11 @@ from within the `commands/` directory
### Running unit tests
There are two versions of the general unit tests. The first includes only the actual code of the project, and is located at `binarycpython/test/main.py`. The second includes the tutorial notebooks, and is located at `binarycpython/test/main_with_notebooks.py`. To run just the notebook tests run `python binarycpython/tests/test_notebooks.py`
### Pulling the JOSS paper article repo
We've written a JOSS paper for `binary_c-python`, which is stored in https://gitlab.com/dhendriks/paper_joss_binarycpython, but is also added as a submodule to this repository. To initialise and pull the repo as a submodule, run
## Submitting an issue or suggestion features/changes
If you encounter an issue with the code, or if you want to suggest extra features or changes in the code, please submit an issue at https://gitlab.com/binary_c/binary_c-python/-/issues/new.
```
git submodule update --init --recursive
```
## FAQ/Issues:
Here we provide a non-exhaustive list of some issues we encountered and solutions for these:
## FAQ:
Here we provide a non-exhaustive list of some installation issues we encountered and solutions for these:
Building issues with binary_c itself:
- see the documentation of binary_c (in doc/).
......
......@@ -18,7 +18,7 @@ Welcome to binary_c-python's documentation!
binary_c_parameters
grid_options_descriptions
Visit the GitLab repo <https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python>
Submit an issue <https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python/-/issues/new>
Submit an issue <https://gitlab.com/binary_c/binary_c-python/-/issues/new>
Indices and tables
==================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment