Skip to content

Commit

Permalink
fix docs, optimise forward model
Browse files Browse the repository at this point in the history
  • Loading branch information
FredDeCeuster committed Jul 27, 2023
1 parent 48b6d8b commit a36d7ab
Show file tree
Hide file tree
Showing 5 changed files with 195 additions and 108 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@ _Probabilistic 3D Reconstruction of Spectral Line Observations._

## About

**p3droslo** is a software library for **probabilistic 3D reconstruction** of astronomical **spectral line observations**.
*p3droslo* is a library for **probabilistic 3D reconstruction** of astronomical **spectral line observations**.

Observations of [spectral lines](https://en.wikipedia.org/wiki/Spectral_line) are indespensible in astronomy, since they encode a wealth of information about the physical and chemical conditions of the medium in which they were formed.
For instance, their narrow extent in frequency space make them very sensitive to Doppler shifts, such that their shape encodes the motion of the medium along the line of sight.
As a result, given a good model for the line formation process and a good inversion method, these physical and chemical properties can be retrieved from observations.
Currently, we mainly focus on retrieving the distributions of the abundance of the chemical species producing the line, the velocity field, and its kinetic temperature.

More information about the model for [spectral line formation](https://p3droslo.readthedocs.io/en/latest/background/spectral_line_formation.html) and the [probabilistic reconstruction methods](https://p3droslo.readthedocs.io/en/latest/background/probabilistic_reconstruction.html) can be found in the [background](https://p3droslo.readthedocs.io/en/latest/background/index.html) pages.

**p3droslo** is built on top of [PyTorch](https://pytorch.org) and benefits a lot from functionality provided by [Astropy](https://www.astropy.org).
*p3droslo* is built on top of [PyTorch](https://pytorch.org) and benefits a lot from functionality provided by [Astropy](https://www.astropy.org).
It is currently developed and maintained by [Frederik De Ceuster](https://freddeceuster.github.io) at [KU Leuven](https://www.kuleuven.be/english/kuleuven/index.html).


Expand Down Expand Up @@ -56,7 +57,7 @@ We are open to contributions to p3droslo. More information can be found [here](h

## Collaborating

We are always interested in collaborating on exciting projects! So, if you have a project or just an idea, or data that might benefit from probabilistic 3D reconstruction or any other thing you can find in this repository, feel free to contact [me](https://freddeceuster.github.io).
We are always interested in collaborating! If you have a project, an idea, or data that might benefit from probabilistic 3D reconstruction or any other method you can find in this repository, feel free to contact [me](https://freddeceuster.github.io).


## Acknowledgements
Expand Down
20 changes: 10 additions & 10 deletions docs/src/benchmarks/Benchmark_1.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": 16,
"id": "6eeb6ce3-3528-47f0-8871-b111aba9042b",
"metadata": {
"tags": []
Expand All @@ -41,7 +41,7 @@
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": 17,
"id": "cb78379c-9e21-49ec-8647-0ade033e44f2",
"metadata": {},
"outputs": [
Expand Down Expand Up @@ -74,7 +74,7 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": 18,
"id": "98d8af03-7472-4142-a7d0-f5c8c304e1ee",
"metadata": {},
"outputs": [
Expand Down Expand Up @@ -102,7 +102,7 @@
},
{
"cell_type": "code",
"execution_count": 4,
"execution_count": 19,
"id": "3d4dbd1f-0ae1-4ee1-b194-81d61b937a2c",
"metadata": {},
"outputs": [],
Expand All @@ -126,7 +126,7 @@
},
{
"cell_type": "code",
"execution_count": 5,
"execution_count": 20,
"id": "d4170b90-a13a-4024-abf1-7fb5d264e78b",
"metadata": {},
"outputs": [],
Expand Down Expand Up @@ -177,7 +177,7 @@
},
{
"cell_type": "code",
"execution_count": 6,
"execution_count": 21,
"id": "d0a0a545-326c-4117-a652-ae9ba2028bb6",
"metadata": {},
"outputs": [],
Expand All @@ -193,15 +193,15 @@
},
{
"cell_type": "code",
"execution_count": 7,
"execution_count": 22,
"id": "8046c94b",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"1.04 ms ± 4.29 µs per loop (mean ± std. dev. of 7 runs, 1,000 loops each)\n"
"976 µs ± 77.1 µs per loop (mean ± std. dev. of 7 runs, 1,000 loops each)\n"
]
}
],
Expand All @@ -212,15 +212,15 @@
},
{
"cell_type": "code",
"execution_count": 8,
"execution_count": 23,
"id": "1847f4d8",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"2.67 ms ± 8.71 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)\n"
"2.17 ms ± 15.6 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)\n"
]
}
],
Expand Down
Loading

0 comments on commit a36d7ab

Please sign in to comment.