Skip to content

Commit 230e2c9

Browse files
committed
update README with pip, acknowledgements, links
1 parent 1879a5a commit 230e2c9

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,14 @@ In this case only the `class` name is required at each level. Other keys (`subcl
5555

5656
## Installation
5757

58+
Using pypi:
59+
60+
```
61+
pip install -U tdtax
62+
```
63+
64+
Or Directly from Github:
65+
5866
```
5967
git clone https://github.com/profjsb/timedomain-taxonomy.git
6068
cd timedomain-taxonomy
@@ -89,4 +97,19 @@ Upon `import tdtax` the taxonomies are merged into a single JSON tree and this i
8997
pytest
9098
```
9199

92-
This uses `PyYAML` to validate the taxonomy against the schema. When you make a PR, your branch will be automatically be tested with Travis CI.
100+
This uses `PyYAML` to validate the taxonomy against the schema. When you make a PR, your branch will be automatically be tested with Travis CI.
101+
102+
## Links
103+
104+
To learn more about taxonomy of variable stars and explosive transients we suggest the following links:
105+
106+
- ["Variable stars" from CSIRO Astronomy and Space Science](https://www.atnf.csiro.au/outreach/education/senior/astrophysics/variable_types.html?newwindow=true)
107+
- [Variability types from GCVS](http://www.sai.msu.su/gcvs/gcvs/vartype.htm?newwindow=true)
108+
- [Supernova classification (astrobites)](https://astrobites.org/2016/12/02/classifying-supernovae/) from A. Villar
109+
110+
## Acknowledgements
111+
112+
113+
We thank the Gordon and Betty Moore Foundation for a [Software SkyPortal grant](https://www.moore.org/grant-detail?grantId=GBMF9122) which covered the cost of the development of this project.
114+
115+
<a href="https://www.moore.org/grant-detail?grantId=GBMF9122"><img width=200 src="https://www.moore.org/content/images/logo-light.png"> </a>

0 commit comments

Comments
 (0)