Skip to content

Commit

Permalink
Update quickstart.rst
Browse files Browse the repository at this point in the history
Hi! My sister and I ran into some issues while following the quickstart. It looks like it is a bit outdated. I have no idea what all those words about astrophysics means, but I have adjusted some imports that didn't seem to be right anymore.

I think there are more imports at the bottom like `sme.solve` that need to be fixed up as well, but we didn't make it that far together. Since helping with the installation is about all I'll do for her, I wanted to at least send you the changes we were already able to identify.
  • Loading branch information
kreibaum authored May 5, 2022
1 parent 8c2ad5f commit 170c50a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/usage/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Quickstart
==========

The first step in each SME project is to create an SME structure
>>> from sme.sme import SME_Struct
>>> from pysme.sme import SME_Structure as SME_Struct

This can be done in done in a few different ways:
* load an existing SME save file (from Python or IDL)
Expand All @@ -14,11 +14,11 @@ This can be done in done in a few different ways:

Either way one has to make sure that a few essential properties are set in the object, those are:
* Stellar parameters (teff, logg, monh, abund)
>>> from sme.abund import Abund
>>> from pysme.abund import Abund
>>> sme.teff, sme.logg, sme.monh = 5700, 4.4, -0.1
>>> sme.abund = Abund.solar()
* LineList (linelist), e.g. from VALD
>>> from sme.vald import ValdFile
>>> from pysme.linelist.vald import ValdFile
>>> vald = ValdFile("linelist.lin")
>>> sme.linelist = vald
* Atmosphere (atmo), the file has to be in PySME/src/sme/atmospheres
Expand Down

0 comments on commit 170c50a

Please sign in to comment.