https://github.com/niess/pumas-docs
Documentation for the PUMAS library
https://github.com/niess/pumas-docs
Last synced: 3 months ago
JSON representation
Documentation for the PUMAS library
- Host: GitHub
- URL: https://github.com/niess/pumas-docs
- Owner: niess
- License: mit
- Created: 2018-04-24T21:13:15.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-15T20:51:50.000Z (about 2 years ago)
- Last Synced: 2025-02-01T19:14:24.677Z (4 months ago)
- Language: Shell
- Homepage: https://pumas.readthedocs.io/en/latest/
- Size: 313 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING.LESSER
Awesome Lists containing this project
README
# Documentation for the PUMAS library
( **S**emi **A**nalytical **MU**ons -or taus- **P**ropagation, *backwards* )
## Description
This repo contains the [source](docs/) of the [PUMAS][PUMAS] documentation as
well as as well as a static HTML description of the C library API. The
documentation is generated with [MkDocs][MKDOCS] and the C
library API with a [Docurium](https://github.com/niess/docurium) fork.
## Usage
The generated documention(s) are available from
[ReadTheDocs](https://pumas.readthedocs.io/en/latest/). Alternativelly you can
also browse the documentation locally with
[MkDocs][MKDOCS] e.g. as:
```bash
git clone https://github.com/niess/pumas-docs.git docs
cd docs/docs
mkdocs serve
```
Then direct your web browser to localhost:8000.
## License
The PUMAS library is under the **GNU LGPLv3** license. See the provided
[LICENSE](LICENSE) and [COPYING.LESSER](COPYING.LESSER) files.
[PUMAS]: http://niess.github.io/pumas
[MKDOCS]: https://www.mkdocs.org