Skip to content

Commit f943ff3

Browse files
jmgarciamorillojmgarciamorillo
committed
Update README.md
1 parent d689a25 commit f943ff3

1 file changed

Lines changed: 29 additions & 30 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,34 @@
77

88
**Solver for Astroparticle Equation of Transport Analysis in Spherical Symmetry**
99

10-
A Python library for simulating cosmic-ray transport and acceleration in astrophysical environments using finite volume methods and operator splitting.
10+
A Python library for simulating cosmic-ray transport in spherically symmetric astrophysical environments using a finite volume method approach.
1111

1212
<br/>
1313

1414
<!-- ─────────────────────── Badges ─────────────────────── -->
1515

16-
[![DOI](https://zenodo.org/badge/1037857186.svg)](https://doi.org/10.5281/zenodo.19468484)<!-- CI & Code Quality -->
17-
[![CI tests](https://img.shields.io/github/actions/workflow/status/jmgarciamorillo/SAETASS/tests.yml?logo=github&logoColor=white&label=CI%20tests&color=F3AC4B)](https://github.com/jmgarciamorillo/SAETASS/actions)
18-
[![Codecov Placeholder](https://img.shields.io/badge/coverage-100%25-F3AC4B?logo=codecov&logoColor=white)](https://codecov.io/gh/jmgarciamorillo/SAETASS) <!-- [![codecov](https://img.shields.io/codecov/c/github/jmgarciamorillo/SAETASS?logo=codecov&logoColor=white&color=F3AC4B)](https://codecov.io/gh/jmgarciamorillo/SAETASS) -->
19-
[![Docs Placeholder](https://img.shields.io/badge/docs-passing-F3AC4B?logo=readthedocs&logoColor=white)](YOUR_DOCS_URL_HERE) <!-- [![Docs](https://img.shields.io/readthedocs/saetass?logo=readthedocs&logoColor=white&color=F3AC4B)](DOCS_URL) -->
20-
[![PyPI Version Placeholder](https://img.shields.io/badge/PyPI-v0.1.0-F3AC4B?logo=pypi&logoColor=white)](https://pypi.org/project/saetass/) <!-- [![PyPI version](https://img.shields.io/pypi/v/saetass?logo=pypi&logoColor=white&color=F3AC4B)](https://pypi.org/project/saetass/) -->
21-
[![Python Versions Placeholder](https://img.shields.io/badge/Python-3.10%20%7C%203.11%20%7C%203.12-F3AC4B?logo=python&logoColor=white)](https://pypi.org/project/saetass/) <!-- [![Python versions](https://img.shields.io/pypi/pyversions/saetass?logo=python&logoColor=white&color=F3AC4B)](https://pypi.org/project/saetass/) -->
22-
[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
23-
[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome!-F3AC4B.svg?logo=github&logoColor=white)](CONTRIBUTING.md)
16+
[![DOI](https://zenodo.org/badge/1037857186.svg)](https://doi.org/10.5281/zenodo.19468484)
17+
[![CI tests](https://img.shields.io/github/actions/workflow/status/jmgarciamorillo/SAETASS/ci.yml?logo=github&logoColor=white&label=tests)](https://github.com/jmgarciamorillo/SAETASS/actions)
18+
[![codecov](https://img.shields.io/codecov/c/github/jmgarciamorillo/SAETASS?logo=codecov&logoColor=white)](https://codecov.io/gh/jmgarciamorillo/SAETASS)
19+
[![Docs](https://img.shields.io/readthedocs/saetass?logo=readthedocs&logoColor=white)](https://saetass.readthedocs.io/en/latest/)
20+
[![PyPI version](https://img.shields.io/pypi/v/saetass?logo=pypi&logoColor=white&color=007EC6)](https://pypi.org/project/saetass/)<!-- [![Python versions](https://img.shields.io/pypi/pyversions/saetass?logo=python&logoColor=white)](https://pypi.org/project/saetass/) -->
21+
[![Project Status: Active](https://img.shields.io/badge/project%20status-active-44CC11.svg?logo=github&logoColor=white)](https://www.repostatus.org/#active)
22+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome!-F3AC4B.svg?logo=github&logoColor=white)](CONTRIBUTING.md)
2423
[![License: BSD-3](https://img.shields.io/badge/license-BSD_3--Clause-F3AC4B.svg?logo=open-source-initiative&logoColor=white)](LICENSE)
25-
[![Last Commit](https://img.shields.io/github/last-commit/jmgarciamorillo/SAETASS?color=F3AC4B&logo=git&logoColor=white)](https://github.com/jmgarciamorillo/SAETASS/commits/main)
26-
[![Issues](https://img.shields.io/github/issues/jmgarciamorillo/SAETASS?color=F3AC4B&logo=github&logoColor=white)](https://github.com/jmgarciamorillo/SAETASS/issues)
27-
[![Stars](https://img.shields.io/github/stars/jmgarciamorillo/SAETASS?color=F3AC4B&logo=github&logoColor=white)](https://github.com/jmgarciamorillo/SAETASS/stargazers)
24+
[![Last Commit](https://img.shields.io/github/last-commit/jmgarciamorillo/SAETASS?logo=git&logoColor=white)](https://github.com/jmgarciamorillo/SAETASS/commits/main)
25+
[![Issues](https://img.shields.io/github/issues/jmgarciamorillo/SAETASS?logo=github&logoColor=white)](https://github.com/jmgarciamorillo/SAETASS/issues)
26+
<!-- [![Stars](https://img.shields.io/github/stars/jmgarciamorillo/SAETASS?logo=github&logoColor=black)](https://github.com/jmgarciamorillo/SAETASS/stargazers) -->
2827

2928

3029
</div>
3130

3231
## Overview
3332

34-
**SAETASS** numerically solves the **astroparticle transport equation** in one-dimensional spherical symmetry; this is, the fundamental equation governing the propagation and energy losses of energetic particles within astrophysical environments such as stellar wind bubbles.
33+
**SAETASS** numerically solves the **astroparticle transport equation** in spherically symmetric astrophysical environments; this is, the fundamental equation governing the propagation and energy losses of energetic particles within astrophysical environments such as stellar wind bubbles.
3534

3635
The package decomposes the full transport equation into independent physical operators: **diffusion**, **advection**, **energy losses** and **source**. It evolves them via mathematically robust **operator-splitting schemes**. Each operator is implemented as a dedicated finite-volume solver, ensuring modularity, testability and physical transparency.
3736

38-
> **For comprehensive documentation**, visit the [SAETASS Documentation](DOCS_URL_PLACEHOLDER).
37+
> **For comprehensive documentation**, visit the [SAETASS Documentation](https://saetass.readthedocs.io/en/latest/).
3938
4039

4140
<div align="center">
@@ -62,20 +61,20 @@ A quick simple installation to get started using SAETASS can be simply done via
6261
pip install saetass
6362
```
6463

65-
This will install the latest stable version of SAETASS from [PyPI](PYPI_URL_PLACEHOLDER).
64+
This will install the latest stable version of SAETASS from [PyPI](https://pypi.org/project/saetass/).
6665

67-
> See the full [Installation Guide](INSTALLATION_GUIDE_URL_PLACEHOLDER) for additional installation options and troubleshooting.
66+
> See the full [Installation Guide](https://saetass.readthedocs.io/en/latest/installation.html) for additional installation options and troubleshooting.
6867
6968
## Quickstart
7069

71-
For step-by-step guides to get started with SAETASS, check the [Tutorials](TUTORIALS_URL_PLACEHOLDER) section of the [documentation](DOCS_URL_PLACEHOLDER).
70+
For step-by-step guides to get started with SAETASS, check the [Tutorials](https://saetass.readthedocs.io/en/latest/tutorials/index.html) section of the [documentation](https://saetass.readthedocs.io/en/latest/).
7271

73-
For complete, more advanced examples, check the [Examples](EXAMPLES_URL_PLACEHOLDER) section of the [documentation](DOCS_URL_PLACEHOLDER).
72+
For complete, more advanced examples, check the [Examples](https://saetass.readthedocs.io/en/latest/examples/index.html) section of the [documentation](https://saetass.readthedocs.io/en/latest/).
7473

7574

7675
## Mathematical background
7776

78-
SAETASS solves the following **astroparticle transport equation** for in spherically symmetric geometry:
77+
SAETASS solves the following **astroparticle transport equation** in spherically symmetric geometry:
7978

8079
$$\frac{\partial f}{\partial t}
8180
+ \frac{1}{r^2}\frac{\partial}{\partial r}\left(r^2 u_\mathrm{w}f\right)
@@ -114,17 +113,17 @@ If you use SAETASS in your research, **please cite the technical paper** to ackn
114113
}
115114
```
116115

117-
<!-- TODO: Uncomment when a Zenodo DOI is assigned -->
118-
For version-specific citations, you may use the **Zenodo DOI** [10.5281/zenodo.XXXXX](https://doi.org/10.5281/zenodo.XXXXX) citation:
116+
For software-specific citations, you may use the **Zenodo DOI** [10.5281/zenodo.19468484](https://doi.org/10.5281/zenodo.19468484) citation:
119117

120118
```bibtex
121-
@software{PLACEHOLDER_FOR_ZENODO_CITATION,
122-
author = {Garcia-Morillo, J. M.},
123-
title = {SAETASS: Solver for Astroparticle Equation of Transport Analysis in Spherical Symmetry},
124-
year = {2026},
125-
publisher = {Zenodo},
126-
doi = {10.5281/zenodo.XXXXX},
127-
url = {https://doi.org/10.5281/zenodo.XXXXX}
119+
@software{saetass_software,
120+
author = {García-Morillo, José María and Menchiari, Stefano and López-Coto, Rubén},
121+
title = "{SAETASS: Solver for Astroparticle Equation of Transport Analysis in Spherical Symmetry}",
122+
month = apr,
123+
year = 2026,
124+
publisher = {Zenodo},
125+
doi = {10.5281/zenodo.19468484},
126+
url = {https://doi.org/10.5281/zenodo.19468484}
128127
}
129128
```
130129

@@ -146,8 +145,8 @@ SAETASS is developed within the [**VHEGA**](https://vhega.iaa.es) research group
146145

147146
<br/>
148147

149-
[![Author](https://img.shields.io/badge/Author-J.%20M.%20Garc%C3%ADa%20Morillo-F3AC4B?logo=github&logoColor=white)](https://github.com/jmgarciamorillo)
150-
[![Email](https://img.shields.io/badge/Email-jmorillo%40iaa.es-D14836?logo=minutemailer&logoColor=white)](mailto:jmorillo@iaa.es)
148+
[![Author](https://img.shields.io/badge/Author-J.%20M.%20García--Morillo-FFFFFF?logo=github&logoColor=white)](https://github.com/jmgarciamorillo)
149+
[![Email](https://img.shields.io/badge/Email-jmorillo%40iaa.es-007EC6?logo=minutemailer&logoColor=white)](mailto:jmorillo@iaa.es)
151150
[![ORCID](https://img.shields.io/badge/ORCID-0009--0008--5232--349X-a6ce39?logo=orcid&logoColor=white)](https://orcid.org/0009-0008-5232-349X)
152151

153152
</div>

0 commit comments

Comments
 (0)