Skip to content
Snippets Groups Projects
Commit 703773c5 authored by Hu Zhao's avatar Hu Zhao
Browse files

docs: update documentation and usage

parent 815b5079
Branches
No related tags found
No related merge requests found
Pipeline #257131 passed
......@@ -89,38 +89,15 @@ python -m ipykernel install --user --name=your_env_name
Now you can start your Notebook, change the kernel to your conda environment, and
use `PSimPy`.
## Usage
Examples are currently in preparation and will be available soon in coming
versions. You may want to have a look at the tests which are currently available
at https://git-ce.rwth-aachen.de/mbd/psimpy. They give a glimpse of how `PSimPy`
can be used. You may download the `tests` folder onto your local machine, and run
any test using `pytest`.
First install `pytest` by
```bash
conda activate your_env_name
conda install pytest
```
Then navigate to the folder where `tests` folder is located on your machine.
You may run all the tests by
```bash
pytest tests/
```
or a specific test like `test_active_learning` by
```bash
pytest tests/test_active_learning.py
```
Some tests save results including plots into temporary folders. The temporary
folders will be deleted automatically if `test_clear_temp_files` is called. If
you want to exclude a specific test such as `test_clear_temp_files`, you may run
```bash
pytest tests/ --ignore=tests/test_clear_temp_files.py
```
## Documentation
The source codes of `PSimPy` contains detailed docstrings which explain how it
can be used. More documentation about the theories is currently in preparation
and will be available soon.
Detailed documentation of `PSimPy` is hosted at https://mbd.pages.git-ce.rwth-aachen.de/psimpy,
including the API and theory (or reference) of each module.
## Usage
Usage examples are provided by the `Example Gallery` at https://mbd.pages.git-ce.rwth-aachen.de/psimpy.
## License
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment