This is the official trident version of the FOGGIE project.
Trident is a Python package for making synthetic spectra from astrophysical simulations. It can also generate fields representing ion abundances from data tables assuming ionization equilibrium.
See the Installation section of the documentation for detailed instructions. This assumes that you already have some version of conda installed. FOGGIE-trident must be install from source.
git clone [email protected]:foggie-sims/trident YOUR_CODE_DIR/trident
cd YOUR_CODE_DIR/trident
pip install -e .
The above will not work if you do not have your ssh key on github or do not have write access to the FOGGIE-trident repo. If you don't think you'll need to do any development yourself, you can do this command to clone instead.
git clone https://github.com/foggie-sims/trident
To pull in the latest changes to trident (or yt, yt_astro_analysis), do the following:
cd YOUR_CODE_DIR/trident
git pull origin main
And you're done! Take the rest of the day off.
Oh right, you want to use trident! Coming soon.
Trident development happens through pull requests. In a nutshell, you create your own branch, make changes, push them to the repo, and issue a pull request.
You can name your branch whatever you want.
git checkout -b NEW_BRANCH_NAME
Make whatever changes you want. Assuming you want to commit every altered file, do the following:
git commit -am 'A bunch of changes.'
Repeat as necessary.
git push origin NEW_BRANCH_NAME
If this is the first time pushing the new branch, you will see a URL for opening a pull request. If not, go to the main repo in a web browser and follow the instructions there to issue your pull request.
After your pull request has been issued, steps 2 and 3 can be repeated to add new changes until your pull request has been merged.
The main branch of trident is called main. Try not to ever push
changes on the main branch directly to the main repository (i.e.,
git push origin main). This will add your changes for
everyone. However, if done accidentally, don't worry, it can be
undone.
- Documentation: http://foggie-trident.readthedocs.org