mirror of
https://github.com/Richard-Sti/csiborgtools.git
synced 2024-10-18 18:25:06 +02:00
53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
# CSiBORGTools
|
|
|
|
Tools for analysing constrained cosmological simulations.
|
|
|
|
|
|
|
|
## 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)
|
|
|
|
|
|
## Examples
|
|
...
|