Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and Fix Documentation #815

Merged
merged 17 commits into from
Apr 6, 2018
Merged

Update and Fix Documentation #815

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
3bc2e5d
Update installation instructions
unoebauer Apr 6, 2018
7577566
Fix link to atomic data base
unoebauer Apr 6, 2018
0d57ff0
Add note about atomic database
unoebauer Apr 6, 2018
e792bcf
Remove broken link to SOCIS logo
unoebauer Apr 6, 2018
efecb19
Remove bugs.rst as it is not part of current docu
unoebauer Apr 6, 2018
945c7d7
Delete changelog since it is no longer maintained
unoebauer Apr 6, 2018
e34d4f4
Remove glossary since it is not part of current docu
unoebauer Apr 6, 2018
bd1355d
Move yml files to separate directory
unoebauer Apr 6, 2018
f2f79f6
Remove unused file
unoebauer Apr 6, 2018
933e6f1
Remove unused docu file
unoebauer Apr 6, 2018
488a8ad
Move and update scripts
unoebauer Apr 6, 2018
0af9c72
Add bibtex entry for v2 zenodo
unoebauer Apr 6, 2018
6bdf4e0
Update credits
unoebauer Apr 6, 2018
51b1a98
Update references
unoebauer Apr 6, 2018
352823e
Update Physics section
unoebauer Apr 6, 2018
e1dde49
Update workflow description
unoebauer Apr 6, 2018
08d511d
Add decay to list of physics topics
unoebauer Apr 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 0 additions & 93 deletions CHANGELOG.rst
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/atomic/current_public_table.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
| file name | uuid1 | data sources | macroatom | zeta | synpp references | database version |
| | | | | | | |
+=================================================================================================================================+=================================================================================================================================+=================================================================================================================================+=================================================================================================================================+=================================================================================================================================+=================================================================================================================================+=================================================================================================================================+
| `kurucz_cd23_chianti_H_He.zip <https://github.com/tardis-sn/tardis-atomdata/raw/master/kurucz_cd23_chianti_H_He.h5.zip>`_ | 6f7b09e887a311e7a06b246e96350010 | **kurucz:** | True | True | True | v0.9 |
| `kurucz_cd23_chianti_H_He.h5 <https://github.com/tardis-sn/tardis-refdata/raw/master/atom_data/kurucz_cd23_chianti_H_He.h5>`_ | 6f7b09e887a311e7a06b246e96350010 | **kurucz:** | True | True | True | v1.0 |
| | | | | | | |
| | | Li I-II, Be I-IV, C I-IV, N I-VI | | | | |
| | | O I-VI, F I-VI, Ne I-VI, Na I-VI | | | | |
Expand Down
134 changes: 0 additions & 134 deletions docs/bugs.rst
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions docs/changelog.rst
View file
Open in desktop

This file was deleted.

18 changes: 15 additions & 3 deletions docs/credits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Credits & Publication Policies
We provide TARDIS as a free, open-source tool. If you are using it, please
adhere to a few policies and acknowledge the TARDIS Team.


Publication Policies
====================

If you use this code for any publications or presentations please acknowledge
it accordingly. Please cite `Kerzendorf & Sim 2014
<http://adsabs.harvard.edu/abs/2014MNRAS.440..387K>`_ and the `zenodo record
<https://zenodo.org/record/17630>`_ of the TARDIS version you are using
<https://doi.org/10.5281/zenodo.592480>`_.

You can use the following bibtex entry:
You can use the following bibtex entries for the Kerzendorf & Sim 2014
reference:

.. code-block:: none

Expand All @@ -36,7 +36,19 @@ You can use the following bibtex entry:
adsurl = {http://adsabs.harvard.edu/abs/2014MNRAS.440..387K},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}


We would appreciate if the following acknowledgement is included in
publications using TARDIS:

.. code-block:: none

This research made use of \textsc{Tardis}, a community-developed software
package for spectral synthesis in supernovae. The development of
\textsc{Tardis} received support from the Google Summer of Code initiative
and from ESA's Summer of Code in Space program. \textsc{Tardis} makes
extensive use of Astropy and PyNE.

User modifications and additions that lead to publications need to be handed
back to the community by incorporating them into this publicly available
version of TARDIS. Please contact the TARDIS team via the `github page
Expand Down
12 changes: 0 additions & 12 deletions docs/glossary.rst
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Using Tardis
* :doc:`TARDIS Configuration <configuration/index>`
* :doc:`Examples <examples/examples>`
* :doc:`Storing simulations to HDF <to_hdf>`
* :doc:`Helper Scripts <scripts/index>`
* :doc:`Credit & Publication Policies <credits>`

======================
Expand Down
16 changes: 6 additions & 10 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Installation
************

Before installing TARDIS, please check its :ref:`requirements
<requirements_label>`. We provide instructions for installing TARDIS using
Anaconda :ref:`guide <anaconda_inst_label>`. If you encounter problems, consult the
<requirements_label>`. We provide :ref:`instructions <anaconda_inst_label>` for installing TARDIS using
Anaconda. If you encounter problems, consult the
:ref:`troubleshooting <troubleshooting_inst_label>` section. Once you have
installed TARDIS, check out :doc:`running` for instructions of how to perform
simple TARDIS calculations.
Expand All @@ -20,9 +20,6 @@ simple TARDIS calculations.
Requirements
============

.. warning::
TARDIS only works on 64-bit python installations.

You can see a list of all the requirements of TARDIS in the `environment definition file <https://raw.githubusercontent.com/tardis-sn/tardis/master/tardis_env27.yml>`_.

TARDIS is using astropy's excellent installation helpers and thus uses similar
Expand Down Expand Up @@ -66,12 +63,11 @@ Since TARDIS has reached a mature state, we recommend always installing the late

pip install git+https://github.com/tardis-sn/tardis

Alternatively, you can manually clone our repository and install TARDIS by

To install the latest stable version of TARDIS simply do (usually outdated)::

pip install tardis-sn


git clone https://github.com/tardis-sn/tardis.git
cd tardis
python setup.py build install


.. _troubleshooting_inst_label:
Expand Down
Loading