Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The vision of the SIMPLE project is to create a *collaborative* database of low-mass stars, brown dwarfs, and directly
imaged exoplanets: a simple archive of complex objects. The tables and fields currently included in the
database are described in the [Documentation](documentation/README.md)
database are described in the [Documentation](docs/README.md)
and currently include names, coordinates, photometry and reference and data provenance information and is visualized
in the [schema](#simple-database-schema) below.
The archive includes kinematics, spectra, modeled and retrieved parameters.
Expand All @@ -20,6 +20,10 @@ If you are not already in the Astropy Slack, [request an account](http://joinsla

To see more details about how this project got started and our initial discussions, check out the [archived running notes in the Wiki](https://github.com/SIMPLE-AstroDB/SIMPLE-db/wiki/Original-Notes).

## Demo Notebooks
- [Querying the Database](docs/notebooks/Demo_Queries_1.0.ipynb)
- [Visualizing with the Database](docs/notebooks/Demo_Visualization_1.0.ipynb)

## Getting Started

If you'd like to set up your own copy of the SIMPLE database, here's what we recommend:
Expand Down Expand Up @@ -88,4 +92,4 @@ The schema for the SIMPLE database is described
in the [Documentation](documentation) and can be found in [`simple/schema.yaml`](simple/schema.yaml).

A graphical representation of the SIMPLE schema:
<img src="https://github.com/SIMPLE-AstroDB/SIMPLE-db/blob/main/documentation/figures/auto_schema.png?raw=true" width=75%>
<img src="https://github.com/SIMPLE-AstroDB/SIMPLE-db/blob/main/docs/figures/auto_schema.png?raw=true" width=75%>
6 changes: 5 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Demo Notebooks
- [Querying the Database](notebooks/Demo_Queries_1.0.ipynb)
- [Visualizing with the Database](notebooks/Demo_Visualization_1.0.ipynb)

# Schema Documentation
This documentation is generated from the [schema.yaml](simple/schema.yaml) file using [build_schema_docs.py](scripts/build_schema_docs.py).

Expand All @@ -24,4 +28,4 @@ This documentation is generated from the [schema.yaml](simple/schema.yaml) file

## Schema Diagram
This diagram is generated from the [schema.yaml](simple/schema.yaml) file using [make_erd.py](scripts/make_erd.py).
![Schema Diagram](figures/auto_schema.png)
![Schema Diagram](figures/auto_schema.png)
Loading