diff --git a/README.md b/README.md index 9e4f09581fe7f520cfa19c145fb0754b2d5e85b8..3b13f200fce16afb3ee6978041e990890334e9ba 100644 --- a/README.md +++ b/README.md @@ -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