Aquila-Consortium/csiborgtools
0
0
Fork 0
mirror of https://github.com/Richard-Sti/csiborgtools.git synced 2024-12-21 14:18:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
rstiskalek 2024-07-25 14:58:42 +01:00
parent b22da9893f
commit 9756175943
1 changed files with 46 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
README.md
View file

@ -1,18 +1,52 @@
# CSiBORG Tools
# CSiBORGTools
Tools for analysing constrained cosmological simulations.
## TODO
- [x] Remove Gaussian priors and switch to uniform. Can the beta preference be a volume effect?
- [x] Relax priors on the calibration parameters as well.
- [x] Verify the effects of resolution (compare how Carrick worsens).
## Installation
```
git clone git@github.com:Richard-Sti/csiborgtools.git
# Go to the cloned directory
cd csiborgtools
# Create a virtual environment
python -m venv venv_csiborgtools
source venv_csiborgtools/bin/activate
python -m pip install --upgrade pip && python -m pip install --upgrade setuptools
# Finally install the cloned package
python -m pip install -e .
```
## License and Citation
If you use or find useful any of the code in this repository, please cite the following paper:
- *Evaluating the reconstruction of individual haloes in constrained cosmological simulations* (Stiskalek+2023) (https://arxiv.org/abs/2310.20672)
```
Copyright (C) 2024 Richard Stiskalek
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
```
## Contributors
- Richard Stiskalek (University of Oxford)
- Harry Desmond (University of Portsmouth)
## To present in the next meeting
- Resolution effects on the goodness-of-fit and the LG velocity.
- CF4 peculiar velocity samples.
## To discuss in the next meeting
- Get Helene Courtois' advice on the CF4 TFR samples.
## Examples
...