First, I would like to thank you for your interest in shamo. If you want to improve the tool, here are the ways you can help:
- Requesting new features
- Finding and reporting bugs
- Enhancing documentation and examples
- Developing shamo
To request a new feature, head over to this page, pick the feature request template and describe as precisely as possible the feature you want to be added.
To report a bug, head over to this page, pick the bug report template and describe as precisely as possible the issue you are facing.
If you want to only edit the documentation, make of fork of the project. Once it is done, clone the repository on your machine and start working on the documentation. If you want to edit the code, take a look at developing shamo.
If you want to participate to the development of shamo, make of fork of the project. Once it is done, clone the repository on your machine and create a virtual environment in the project directory following these steps:
python3 -m venv --prompt shamo .venv
.venv/bin/activate
python3 -m pip install -r requirements.txt
python3 -m pip install -r dev-requirements.txt
python3 -m pip install -e .Make sure you also have Gmsh, GetDP and CGAL installed on your computer.
This project uses black for its code formatting so make sure to either integrate it to your code editor to apply the format directly in it or to install a pre-commit hook.
Once everything is properly setup, create a new branch called feature/{feature_name} and start writing code.
When you are done working, create a pull request. We'll review the modifications you did as soon as possible.
Many features can be implemented in shamo. Here are the instructions to add some of them.
Everything in shamo is defined as a pair of objects where the problem defines the computation and the solution stores the result.
The structure of shamo is split into the core package which contains all the features shared by all or at least some of the problems/solutions and the modalities such as eeg or hd_tdcs containing the actual processes. Those packages are further split into sub-packages focused on a single process.
src/shamo/
├── cli/ # Contain the command line interface.
├── core/ # Contain the features shared by many objects.
└── modality/ # Define a new modality with one or multiple processes.
└── process/ # Define a process with its problems and solutions.
├── parametric/ # Define the parametric problem-solution pair of the process.
└── single/ # Define the single problem-solution pair of the process.To add a new modality called new_modality, add the sub-package in the src/shamo directory as: