# MODEL FOR ROTATION OF STARS (MORS)
**This code is distributed as a python package for the purpose of the [PROTEUS framework](https://github.com/FormingWorlds/PROTEUS), a coupled simulation tool for the long-term evolution of atmospheres and interiors of rocky planets.
The MORS package solves specifically the stellar rotation and evolution. It is based on the [original code](https://www.aanda.org/articles/aa/pdf/2021/05/aa38407-20.pdf) and model developed by Colin P. Johnstone.**
**Original Author:** Colin P. Johnstone
This code solves the stellar rotation and XUV evolution model presented in Johnstone et al. (2021). The package can be used to calculate evolutionary tracks for stellar rotaton and X-ray, EUV, and Ly-alpha emission for stars with masses between 0.1 and 1.25 Msun and has additional functionality such as allowing the user to get basic stellar parameters such as stellar radius and luminosity as functions of mass and age using the stellar evolution models of Spada et al. (2013). When publishing results that were calculated using this code, both the Johnstone et al. (2020) paper and Spada et al. (2013) should be cited.
**NOTE:** This version contains the fix for the error in the equation converting EUV1 to EUV2.
## 1. INSTALLATION
### 1.1. Basic install
The Forming Worlds Mors package is available on PyPI. Run the following command to install
```
pip install fwl-mors
```
### 1.2. Developper install
You can alternatively download the source code from GitHub somewhere on your computer using
```
git clone git@github.com:FormingWorlds/MORS.git
```
Then run the following command inside the main directory to install the code (check the pyproject.toml file for dependencies)
```
pip install -e .
```
### 1.3. Stellar evolution tracks
The code requires also a set of stellar evolution data, stored in the [OSF repository](https://osf.io/9u3fb/).
You can use `mors download all` to download the data. This will download and extract package stellar evolution tracks data.
By default, MORS stores the data in based on the [XDG specification](https://specifications.freedesktop.org/basedir-spec/latest/).
You can check the location by typing `mors env` in your terminal.
You can override the path using the `FWL_DATA` environment variable, e.g.
```console
export FWL_DATA=...
```
Where ... should be replaced with the path to your main data directory. To make this permanent on Ubuntu, use
```console
gedit ~/.profile
```
and add the export command to the bottom of the file.
Alternatively, when creating a star object in your Python script, you can specify the path to a directory where evolution tracks are stored using the starEvoDir keyword
```python
import mors
myStar = mors.StarEvo(starEvoDir=...)
```
where ... can be given as the path relative to the current directory. When this is done, no environmental variable needs to be set.
## 2. EVOLUTIONARY CALCULATIONS
The main way that the user is meant to interact with the code is through the Star class. The user can create an instance of the star class, specifying only the mass and star's initial (1 Myr) rotation rate using the Mstar and Omega0 keyword arguments. This can be done for a star with a mass of 1 Msun and an initial rotation of 10x the modern Sun using
```python
star = mors.Star(Mstar=1.0, Omega=10.0)
```
The user can instead set the initial rotation rate using the Prot keyword argument giving the surface rotation period in days.
```python
star = mors.Star(Mstar=1.0, Prot=2.7)
```
Alternatively, the user can specify starting values for both the core and envelope rotation rates using the OmegaEnv and OmegaCore arguments, though this is usually not recommended.
If the user instead specifies an age the Age and Omega keyword argument, the code will look for the track that passes through the specified surface rotation rate at the specified age. The surface rotation rate can be specified either using Omega or OmegaEnv.
```python
star = mors.Star(Mstar=1.0, Age=100.0, Omega=50.0)
```
In this case, the code will search for a rotation track that has a surface rotation rate that is 50x the current Sun's at an age of 100 Myr. It is not recommended to do this when the age of the star is so large that the rotation rates of stars with different initial rotation rates have converged (i.e. Age should only be specified if it is low enough that there is still a large spread in rotation rates for that mass at that age). In not all cases will it actually be able to find a physically realistic rotation rate, for example if the rotation rate specified is unreaslistically large.
The code will calculate evolutionary tracks for all rotation and activity quantities available. These include surface rotation rate, OmegaEnv, and X-ray luminosity, Lx. To see a list of quantities with calculated evolutionary tracks, use the PrintAvailableTracks() attribute of the Star class.
```python
star.PrintAvailableTracks()
```
This gives units for all quantities. This can also be used to get units for each of the available quantities. Tracks for each of the quantities are held in numpy arrays and can be accessed using the Tracks dictionary, which is an attribute of the Star class. For example, the user can plot evolutionary tracks for Lx using
```python
plt.plot(star.Tracks['Age'], star.Tracks['Lx'])
```
Alternatively, numpy arrays for each quantity are attributes of the Star class with the name of the quantity followed by 'Track', so the above can be replaced with
```python
plt.plot(star.AgeTrack, star.LxTrack)
```
Units are held in the dictionary Units, which is also an attribute of the Star class. For example, to see the units of Lx, the user can use
```python
print(star.Units['Lx'])
```
The value of one of these quantities at a given age can be output using the Value() attribute of the Star class giving age the Myr and a string with the name of the desired quantity. These can be given either as positional or as keyword arguments. For example, to print Lx at 150 Myr to the screen you can use
```python
print(star.Value(150.0,'Lx'))
```
or
```python
print(star.Value(Age=150.0, Quantity='Lx'))
```
More simply, the user can use the function with the name of the desired quantity, so the two above lines could be replaced with
```python
print(star.Lx(150.0))
```
Instances of the Star class can be saved using the Save (or save) functions,
```python
star.Save()
```
By default, the data will be saved into a file called 'star.pickle' but using the user can specify the name of the file using the filename argument in the call to Save(). Saved stars can be loaded using the Load() function.
```python
star = mors.Load("star.pickle")
```
## 3. MODEL DISTRIBUTION AND PERCENTILES
It is possible when creating an instance of the Star class to specify the initial rotation as a percentile of the model distribution from Johnstone et al. (2020). This model distribution is composed of measured rotation distributions from several clusters with ages of ~150 Myr evolved back to 1 Myr. To get the masses and initial rotation rates of the model cluster, use the function ModelCluster().
```python
Mstar , Omega = ModelCluster()
```
If this model cluster is used in any research, please cite the papers listed in Table 1 of Johnstone et al. (2020) for the 150 Myr age bin as the original sources for the rotation measurements (note that the function ModelCluster does not return these measurements, but 1 Myr rotation rates for these stars derived from their measurments using the rotational evolution model of Johnstone et al. 2020). To evolve this cluster, use the Cluster class as described below.
When creating an instance of the Star class, use the keyword argument percentile to set the initial rotation rate to a percentile of this distribution. This can either be given as a float or int between 0 and 100 or as a string, with the three options being 'slow', 'medium', and 'fast', corresponding to the 5th, 50th, and 95th percentiles of the rotation distribution. For example
```python
star = mors.Star(Mstar=1.0, percentile=5.0)
```
This creates a solar mass star with an initial rotation rate equal to the 5th percentile of the rotation distribution at 1 Myr, as determined from our model cluster. This is equivalent to
```python
star = mors.Star(Mstar=1.0, percentile='slow')
```
To calculate this percentile, the parameter dMstarPer is used and can be set if the user sets up their own parameters as discussed above. This is set by default to 0.1, meaning that all stars within 0.1 Msun of the specified Mstar will be considered.
Regardless of how a star is setup, the percentile in the model distribution is calculated after the evolutionary tracks are calculated and stored in the percentile attribute of the class. It can be seen using
```python
print(star.percentile)
```
If the user wants to find out the percentile of a given rotation race for a given mass, they can use the the Percentile function, specifying the star's mass and surface rotation rate, either as a rotation velocity in OmegaSun using the Omega (or OmegaEnv) keyword argument, or as a rotation period in days using the Prot keyword argument. For example
```python
print(mors.Percentile(Mstar=1.0, Omega=10.0))
```
This will print to the screen where in the starting (1 Myr) distribution a solar mass star rotating at 10x the current Sun is, using the model distribution from Johnstone et al. (2020). Or for a star was a 1 day rotation period
```python
print(mors.Percentile(Mstar=1.0, Prot=1.0))
```
Alternatively, the user can specify the percentile and get the corresponding rotation rate
```python
print(mors.Percentile(Mstar=1.0, percentile=10.0))
```
This prints the rotation rate of the 10th percentile for solar mass stars in OmegaSun. If the user wants to use a different cluster distribution, instead of the 1 Myr model distribution used in Johnstone et al. (2020), the masses and rotation rates of the stars in this distribution can be input. The masses are input as an array of masses in Msun using the MstarDist keyword argument, and the rotation rates can be input either as an array of surface angular velocities in OmegaSun using the OmegaDist keyword argument or as an array of rotation periods in days using the ProtDist keyword argument.
## 4. SETTING SIMULATION PARAMETERS
In addition to just the masses and initial rotation rates, the basic behavior of the code depends on a large number of parameters all of which have default values and do not need to be changed by the user. These default values cause the code to run the evolutionary model for rotation and XUV emission described in Johnstone et al. (2020) and generally do not need to be changed by the user. However, if the user wishes, these parameters can be changed.
In general, simulation parameters are held in a dictionary called 'params' within the code, and the user can specify this parameter dictionary when creating a instance of the Star class. When this is not done, the code will use the paramsDefault dictionary created in parameters.py in the source code. To use user specified set of parameters, the user must first generate a parameter dictionary using the NewParams() function.
```python
myParams = mors.NewParams()
```
This will create a dictionary that is identical to paramsDefault that the user can edit as they want. For example, to change the parameter param1 to 1.5 and param2 to 2.5, use
```python
myParams = mors.NewParams()
myParams['param1'] = 1.5
myParams['param2'] = 2.5
```
Alternatively, and probably preferrably, this can also be done in the initial call to NewParams using keyword arguments.
```python
myParams = mors.NewParams(param1=1.5, param2=2.5)
```
This user should then input this as a keyword argument when creating an instance of the Star class.
```python
star = mors.Star(Mstar=1.0, Omega=10.0, params=myParams)
```
To see a complete list of all parameters that should be set, the user can use the PrintParams() function.
```python
mors.PrintParams()
```
Or can simply look into the parameters.py file in the main directory where Mors is installed.
The user can set the keyword parameter AgesOut when creating a new Star object to a number or a numpy array and this will cause the code to only include these ages and the starting age in the evolutionary tracks. The ages should be given in Myr. For example
```python
star = mors.Star(Mstar=1.0, Omega=10.0, AgesOut=100.0)
```
will cause the evolutionary tracks to only contain the starting age of 1 Myr and the specified age of 100 Myr. Similarly
```python
star = mors.Star(Mstar=1.0, Omega=10.0, AgesOut=np.array([100.0,200.0,300.0,400.0]))
```
will cause the evolutionary tracks to contain 1 Myr, and the specified 100, 200, 300, and 400 Myr ages. The simulations will also end at the oldest year in the array. This array should be in ascending order. This is not recommended if the user wants to extract quantities at arbitrary ages along evolutionary tracks, for example using star.Lx(Age), since these functions interpolate between the values and if there are not enough age bins in the evolutionary tracks then these results can be inaccurate. Note that having two many age bins in the AgesOut array, e.g. with AgesOut=np.linspace(1.0,5000.0,10000), will cause the calculations of the evolutionary tracks to be very slow.
## 5. ROTATION AND ACTIVITY QUANTITES
The code gives the user the ability to use the basic functions for calculating many activity related quantities as functions os stellar properties. For example, the user can calculate XUV luminosities from stellar mass, age, and rotation rates using the Lxuv function. For example,
```python
Lxuv = mors.Lxuv(Mstar=1.0, Age=5000.0, Omega=10.0)
```
This gives a dictionary holding X-ray, EUV, and Lyman-alpha luminosities for a 5000 Myr old solar mass star rotating 10 times faster than the Sun. The surface rotation rate can be specified as a rotation velocity using the Omega or OmegaEnv arguments or as a rotation period in days using the Prot argument, e.g.
```python
Lxuv = mors.Lxuv(Mstar=1.0, Age=5000.0, Prot=1.0)
```
This is similar to above, but for a star with a rotation period of 1 day.
The dictionary returned contains the following luminosities, all in erg s<sup>-1</sup>
- Lxuv - 0.517 to 92 nm
- Lx - 0.517 to 12.4 nm (0.1 to 24 keV)
- Leuv1 - 10 to 36 nm
- Leuv2 - 36 to 92 nm
- Leuv - 10 to 92 nm
- Lly - Lymann-alpha emission line
The dictionary also contains surface fluxes (e.g. Fxuv, Fx, Feuv1,...) in erg s<sup>-1</sup> cm<sup>-2</sup> and luminosities normalised to bolometric luminosities (e.g Rxuv, Rx, Reuv1,...).
The user can also just get the X-ray luminosity as a float using Lx()
```python
Lx = mors.Lx(Mstar=1.0, Age=5000.0, Omega=10.0)
```
And similarly for the EUV and Lymann-alpha luminosities
```python
Leuv = mors.Leuv(Mstar=1.0, Age=5000.0, Omega=10.0)
Lly = mors.Lly(Mstar=1.0, Age=5000.0, Omega=10.0)
```
The function Leuv() also takes the keyword argument 'band' which can be used to specify the band desired (=0 for 10-92 nm; =1 for 10-32 nm; =2 for 32-92 nm).
The above function calculate an average Lx for a star given its mass, age, and rotation. In reality there is a scatter around these values that appear somewhat random, likely due to variability. This scatter can be described as a log normal probability density function. To calculate this scatter for X-ray luminosity, the user can use the XrayScatter() function.
```python
deltaLx = mors.XrayScatter(Lx)
```
Here, the user should just enter the X-ray luminosity either as a single value or a numpy array and it returns the deltaLx from the equation LxScattered = Lx + deltaLx, where Lx is the value with this scatter not included and LxScattered is the value with it included. The user can also send in Fx or Rx to the function and get deltaFx and deltaRx. Note that these values are random and will be different each time. The width of the random distribution is set by sigmaXray in the parameter file and can be set using the params keyword argument.
To get scatter values for EUV, Ly-alpha, and all other parameters returned by Lxuv() described above, use XUVScatter() which takes the dictionary returned by Lxuv().
```python
Lxuv = mors.Lxuv(Mstar=1.0, Age=5000.0, Omega=10.0)
deltaLxuv = mors.XUVScatter(Lxuv)
```
The return value is a dictionary containing delta values for the same quantities in Lxuv.
If the user wants a more detailed set of parameters for a given star, the ExtendedQuantities() function can be used and in this case, the star's mass, age, and envelope and core rotation rates must be specified.
```python
quantities = ExtendedQuantities(Mstar=1.0, Age=5000.0, OmegaEnv=10.0, OmegaCore=10.0)
```
This returns a larger dictionary with many other quantities, including some basic stellar properties such as radius and moment of inertia, the mass loss rate in the wind, the dipole field strength, and all of the torques acting on the star to influence its rotation. A list of the available parameters can be seen with
```python
list(quantities)
```
## 6. STELLAR EVOLUTION QUANTITIES
The rotation and activity evolution model requires that various basic stellar properties such as bolometric luminosity, radius, and convective turnover time, can be accessed at all ages for for all masses within the mass range considered (0.1 to 1.25 Msun). These are calculated using the evolutionary tracks fronm Spada et al. (2013) and the functions that do this are available to the user. First import the Mors package
```python
import mors
```
The stellar mass for a 1.0 Msun star with an age of 1000 Myr can be calculated using
```python
Rstar = mors.Rstar(1.0, 1000.0)
```
The functions available are
- Rstar - radius (Rsun)
- Lbol - bolometric luminosity (Lsun)
- Teff - effective temperature (K)
- Itotal - total moment of inertia in (g cm<sup>2</sup>)
- Icore - core moment of inertia in (g cm<sup>2</sup>)
- Ienv - envelope moment of inertia in (g cm<sup>2</sup>)
- Mcore - core mass in (Msun)
- Menv - envelope mass in (Msun)
- Rcore - core radius in (Rsun)
- tau - convective turnover time (days)
- dItotaldt - rate of change of total moment of inertia (g cm<sup>2</sup> Myr<sup>-1</sup>)
- dIcoredt - rate of change of core moment of inertia (g cm<sup>2</sup> Myr<sup>-1</sup>)
- dIenvdt - rate of change of envelope moment of inertia (g cm<sup>2</sup> Myr<sup>-1</sup>)
- dMcoredt - rate of change of core mass (Msun Myr<sup>-1</sup>)
- dRcoredt - rate of change of core radius (Rsun Myr<sup>^-1</sup>)
Note that core and envelope have the definitions from the rotation model, so the 'core' is not the hydrogen burning core as it would typically be defined but everything interior to the outer convective zone, and the envelope is the outer convective zone. All of these functions take stellar mass in Msun and age in Myr. Alternatively, the user can call the function Value which takes the same two inputs and then the parameter name as a string. For example
```python
Rstar = mors.Value(1.0, 1000.0, 'Rstar')
```
which is equivalent to the above example.
In all cases, multiple values for mass and age can be input using lists or numpy arrays and the functions will return numpy arrays holding the results for each input case. For example, if stellar mass is input as a 1D array or list of length 5, the result will be a length 5 numpy array. If both stellar mass and age are input as arrays, the result will be a 2-dimensional array of length len(Mstar)xlen(Age). Additionally, in the call to Value(), the string holding the parameter to calculate for can also be input as a list of strings, in which case the variable retuned will have an additional dimension with values for each of the input quantities.
The first time one of these functions is called, the code loads all of the evolutionary tracks from the Spada et al. (2013) model. These will be written to the directors in the file SEmodels.pickle in the main directory of the evolutionary models and this file will be used to load the models in the future. This file can be safely deleted if the user wants since this will just cause the code to remake it next time it is needed. The code then does a linear interpolation between mass and age bins to get values at the input masses and ages. This can be time consuming, especially if an interpolation between mass bins is required, which will be the case if the input age is not an integer multiple of 0.05 Msun. The user can load a full evolutionary track for a specific stellar mass using LoadTrack(). For example, to load a track for a 1.02 Msun star, use
```python
mors.LoadTrack(1.02)
```
If a track for that specific mass is already loaded, this will do nothing.
## 7. CLUSTER EVOLUTION CALCULATIONS
The code allows the user to calculate the evolution of stellar clusters in addition to single stars. This is done using the Cluster class. An instance of the Cluster class can be created in much the same way as an instance of the Star class using the same input keyword arguments. The only difference is that the masses and rotation rates of the stars should be given as arrays or lists
```python
Mstar = np.array([1.0, 0.5, 0.75])
Omega = np.array([ 10.0, 10.0, 10.0])
cluster = mors.Cluster(Mstar=Mstar, Omega=Omega)
```
This will create a cluster composed of three stars and immediately calculate evolutionary tracks for each. To see the progress of these calculations printed to the screen, use the verbose keyword argument
```python
cluster = mors.Cluster(Mstar=Mstar, Omega=Omega, verbose=True)
```
As in the Star class, it is possible to specify the Age keyword argument. If this is not specified, the code will assume the Omega values are starting (1 Myr) rotation rates. If it is specified, the code will fit the rotation tracks such that they pass through the specified rotation rates at the speficied ages. If Age is specified as a single value (in Myr), it will be assumed that all stars have that age, and if it is specified as a numpy array then the array should have the same lengths as Mstar and Omega and the ages will be assumed individually for each star. As with the Star class, it is possible to input simulation parameters using the params keyword argument (see above).
As in the Star class, an instance of the Cluster class can be saved using the Save (or save) function
```python
cluster.Save()
```
By default, the data will be saved into a file called 'cluster.pickle' but using the user can specify the name o the file using the filename argument in the call to Save(). Saved clusters can be loaded using the Load() function.
```python
cluster = mors.Load("cluster.pickle")
```
This is advisable since the evolutionary tracks for clusters can take a lot of time to calculate if there are lots of stars.
The Star class instances for each star in the cluster is held in the stars list, which is an attribute of this class. To plot Lx tracks for each star for example, the user can use
```python
plt.plot(cluster.stars[0].AgeTrack, cluster.stars[0].LxTrack)
plt.plot(cluster.stars[1].AgeTrack, cluster.stars[1].LxTrack)
plt.plot(cluster.stars[2].AgeTrack, cluster.stars[2].LxTrack)
```
Alternatively, each star is an attribute of the class instance and has the name 'star' followed by its place in the list (starting at zero), so the above can be replaced with
```python
plt.plot(cluster.stars0.AgeTrack, cluster.stars0.LxTrack)
plt.plot(cluster.stars1.AgeTrack, cluster.stars1.LxTrack)
plt.plot(cluster.stars2.AgeTrack, cluster.stars2.LxTrack)
```
To get values for each star at a given age of a given parameter, the user can use the Values() function, specifying the age in Myr and a string for the quantity to retrieve. For example,
```python
Lx = cluster.Values(Age=100.0, Quantity='Lx')
```
This gives an array with Lx for each star in the cluster. Alternatively, as with the Star class, each quantity can be specified using its own function and the above is equivalent to.
```python
Lx = cluster.Lx(100.0)
```
So to plot the Lx distribution for a cluster at 100 Myr, the user can use
```python
plt.scatter(cluster.Mstar, cluster.Lx(100.0))
```
In Johnstone et al. (2020), many of the results are based on a composite cluster that is often referred to in the paper as the model cluster. This is composed of measured rotation distributions from several clusters with ages of ~150 Myr evolved back to 1 Myr.
To get the masses and initial rotation rates of the model cluster, use the function ModelCluster().
```python
Mstar , Omega = ModelCluster()
```
If this model cluster is used in any research, please cite the papers listed in Table 1 of Johnstone et al. (2020) for the 150 Myr age bin as the original sources for the rotation measurements (note that the function ModelCluster does not return these measurements, but 1 Myr rotation rates for these stars derived from their measurments using the rotational evolution model of Johnstone et al. 2020). This cluster can then be evolved in the usual way
```python
Mstar , Omega = ModelCluster()
cluster = mors.Cluster(Mstar=Mstar, Omega=Omega)
```
The Cluster class also has a function that allows the user to find where in the distribution a star with a given mass and surface rotation rate rate is at a given age. This uses the Percentile function discussed above applied to the rotation distribution of this cluster at the specified age.
## 8. HABITABLE ZONE BOUNDARIES
Using the formulae of Kopparapu et al. (2013) and the luminosities and effective temperatures from the stellar models of Spada et al. (2013), the user can calculate the orbital distances of the habitable zone boundaries as a function of stellar mass and age. Please cite these two papers if using the output of this function. The HZ boundaries are calculated using the aOrbHZ function.
```python
aOrbHZ = mors.aOrbHZ(Mstar=1.0)
```
In this case, the function returns a dictionary holding the orbital distances in AU in a dictionary. The six values in the dictionary are 'RecentVenus', 'RunawayGreenhouse', 'MoistGreenhouse', 'MaximumGreenhouse', 'EarlyMars', and 'HZ'. While the first five are obvious and correspond to the boundaries in Kopparapu et al. (2013), the final one is defined in Johnstone et al. (2020) as the average of the runaway greenhouse and moist greenhouse orbital distances. For example, to see these values
```python
print(aOrbHZ['RecentVenus'])
print(aOrbHZ['RunawayGreenhouse'])
print(aOrbHZ['MoistGreenhouse'])
print(aOrbHZ['MaximumGreenhouse'])
print(aOrbHZ['EarlyMars'])
print(aOrbHZ['HZ'])
```
Mstar can be input as a numpy array in which case the dictionary will contain arrays with values for each mass. By default the orbital distances are calculated assuming stellar parameters at 5000 Myr. The user can also set the age in Myr using the Age keyword argument
```python
aOrbHZ = mors.aOrbHZ(Mstar=1.0, Age=1000.0)
```
## 9. ACTIVITY LIFETIMES
The code contains functions that calculate how long stars remain above certain acitivty thresholds. Firstly, the function ActivityLifetime() takes an evolutionary track and returns when the value of the track goes below a certain threshold. For example
```python
AgeThreshold = mors.ActivityLifetime(Age=star.AgeTrack, Track=star.LxTrack, Threshold=1.0e28)
```
This will tell us when the star's Lx dropped below 10<sup>28</sup> erg s<sup>-1</sup>. If the star crosses this threshold multiple times, only the final time will be returned. If it never goes below this threshold then the final age in the track will be returned and if it is never above this threshold then 0.0 will be returned. If the user wants to set a maximum age so that the code only looks for crossings of the threshold below this age then this can be done using the AgeMax keyword argument
More recommended though is to use the function of the same name in the Star class, where the quantity of interest should be specified as a string.
```python
AgeThreshold = star.ActivityLifetime(Quantity='Lx', Threshold=1.0e28)
```
This does the same thing. Valid options for Quantity are 'Lx', 'Fx', 'Rx', 'FxHZ', 'Leuv1', 'Feuv1', 'Reuv1', 'Feuv1HZ', 'Leuv2', 'Feuv2', 'Reuv2', 'Feuv2HZ', 'Leuv', 'Feuv', 'Reuv', 'FeuvHZ', 'Lly', 'Fly', 'Rly', and 'FlyHZ'. It is also possible here to specify AgeMax. If the user wants to know how long the star remained saturated, Threshold can be given with the string 'sat'.
```python
AgeSaturated = star.ActivityLifetime(Quantity='Lx', Threshold='sat')
```
Note that when doing this, the value of Quantity should not influence the return value since all XUV quantities saturate at the same time, though it still must be set to a valid option.
The Cluster class also contains this function and is called in the exact same way, returning this time the values for each star in the cluster as a numpy array.
```python
AgeThreshold = cluster.ActivityLifetime(Quantity='Lx', Threshold=1.0e28)
```
## 10. BARAFFE STELLAR EVOLUTION QUANTITIES
The Forming Worlds MORS package also provides access to stellar evolution quantities according to the Baraffe model (Baraffe et al., 2002). The evolution track for a given star mass Mstar, between 0.01 and 1.4 Msun, can be loaded into memory with the command
```python
baraffe = mors.BaraffeTrack(Mstar)
```
The command performs mass interpolation (if needed) and time interpolation into a fine grid of 5e4 points. For a given time, the user can then access to the luminosity, the solar constant and the stellar radius with the following functions
- Stellar radius in Rsun, time in yr
```
Rstar = baraffe.BaraffeStellarRadius(time)
```
- Bolometric flux in Lsun, time in yr
```
Lbol = baraffe.BaraffeLuminosity(time)
```
- Flux scaled by the star-planet distance in W m<sup>-2</sup>, time in yr, distance in AU
```
Flux = baraffe.BaraffeSolarConstant(time, distance)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "fwl-mors",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "exoplanet, stellar evolution",
"author": null,
"author_email": "\"Colin P. Johnstone\" <colinjohnstone@gmail.com>, Harrison Nicholls <harrison.nicholls@physics.ox.ac.uk>, Laurent Soucasse <l.soucasse@esciencecenter.nl>",
"download_url": "https://files.pythonhosted.org/packages/96/72/59185538e65ba6ef5f7e6f4f08274ba72ab922fb41ad1a66d427ba29d8f2/fwl_mors-25.2.26.tar.gz",
"platform": null,
"description": "\n\n# MODEL FOR ROTATION OF STARS (MORS)\n\n**This code is distributed as a python package for the purpose of the [PROTEUS framework](https://github.com/FormingWorlds/PROTEUS), a coupled simulation tool for the long-term evolution of atmospheres and interiors of rocky planets.\nThe MORS package solves specifically the stellar rotation and evolution. It is based on the [original code](https://www.aanda.org/articles/aa/pdf/2021/05/aa38407-20.pdf) and model developed by Colin P. Johnstone.**\n\n**Original Author:** Colin P. Johnstone\n\nThis code solves the stellar rotation and XUV evolution model presented in Johnstone et al. (2021). The package can be used to calculate evolutionary tracks for stellar rotaton and X-ray, EUV, and Ly-alpha emission for stars with masses between 0.1 and 1.25 Msun and has additional functionality such as allowing the user to get basic stellar parameters such as stellar radius and luminosity as functions of mass and age using the stellar evolution models of Spada et al. (2013). When publishing results that were calculated using this code, both the Johnstone et al. (2020) paper and Spada et al. (2013) should be cited.\n\n**NOTE:** This version contains the fix for the error in the equation converting EUV1 to EUV2.\n\n## 1. INSTALLATION\n\n### 1.1. Basic install\n\nThe Forming Worlds Mors package is available on PyPI. Run the following command to install\n\n```\npip install fwl-mors\n```\n### 1.2. Developper install\n\nYou can alternatively download the source code from GitHub somewhere on your computer using\n\n```\ngit clone git@github.com:FormingWorlds/MORS.git\n```\n\nThen run the following command inside the main directory to install the code (check the pyproject.toml file for dependencies)\n\n```\npip install -e .\n```\n\n\n### 1.3. Stellar evolution tracks\n\nThe code requires also a set of stellar evolution data, stored in the [OSF repository](https://osf.io/9u3fb/).\n\nYou can use `mors download all` to download the data. This will download and extract package stellar evolution tracks data.\n\nBy default, MORS stores the data in based on the [XDG specification](https://specifications.freedesktop.org/basedir-spec/latest/).\nYou can check the location by typing `mors env` in your terminal.\nYou can override the path using the `FWL_DATA` environment variable, e.g.\n\n```console\nexport FWL_DATA=...\n```\n\nWhere ... should be replaced with the path to your main data directory. To make this permanent on Ubuntu, use\n\n```console\ngedit ~/.profile\n```\n\nand add the export command to the bottom of the file.\n\nAlternatively, when creating a star object in your Python script, you can specify the path to a directory where evolution tracks are stored using the starEvoDir keyword\n\n```python\nimport mors\nmyStar = mors.StarEvo(starEvoDir=...)\n```\n\nwhere ... can be given as the path relative to the current directory. When this is done, no environmental variable needs to be set.\n\n## 2. EVOLUTIONARY CALCULATIONS\n\nThe main way that the user is meant to interact with the code is through the Star class. The user can create an instance of the star class, specifying only the mass and star's initial (1 Myr) rotation rate using the Mstar and Omega0 keyword arguments. This can be done for a star with a mass of 1 Msun and an initial rotation of 10x the modern Sun using\n\n```python\nstar = mors.Star(Mstar=1.0, Omega=10.0)\n```\n\nThe user can instead set the initial rotation rate using the Prot keyword argument giving the surface rotation period in days.\n\n```python\nstar = mors.Star(Mstar=1.0, Prot=2.7)\n```\n\nAlternatively, the user can specify starting values for both the core and envelope rotation rates using the OmegaEnv and OmegaCore arguments, though this is usually not recommended.\n\nIf the user instead specifies an age the Age and Omega keyword argument, the code will look for the track that passes through the specified surface rotation rate at the specified age. The surface rotation rate can be specified either using Omega or OmegaEnv.\n\n```python\nstar = mors.Star(Mstar=1.0, Age=100.0, Omega=50.0)\n```\n\nIn this case, the code will search for a rotation track that has a surface rotation rate that is 50x the current Sun's at an age of 100 Myr. It is not recommended to do this when the age of the star is so large that the rotation rates of stars with different initial rotation rates have converged (i.e. Age should only be specified if it is low enough that there is still a large spread in rotation rates for that mass at that age). In not all cases will it actually be able to find a physically realistic rotation rate, for example if the rotation rate specified is unreaslistically large.\n\nThe code will calculate evolutionary tracks for all rotation and activity quantities available. These include surface rotation rate, OmegaEnv, and X-ray luminosity, Lx. To see a list of quantities with calculated evolutionary tracks, use the PrintAvailableTracks() attribute of the Star class.\n\n```python\nstar.PrintAvailableTracks()\n```\n\nThis gives units for all quantities. This can also be used to get units for each of the available quantities. Tracks for each of the quantities are held in numpy arrays and can be accessed using the Tracks dictionary, which is an attribute of the Star class. For example, the user can plot evolutionary tracks for Lx using\n\n```python\nplt.plot(star.Tracks['Age'], star.Tracks['Lx'])\n```\n\nAlternatively, numpy arrays for each quantity are attributes of the Star class with the name of the quantity followed by 'Track', so the above can be replaced with\n\n```python\nplt.plot(star.AgeTrack, star.LxTrack)\n```\n\nUnits are held in the dictionary Units, which is also an attribute of the Star class. For example, to see the units of Lx, the user can use\n\n```python\nprint(star.Units['Lx'])\n```\n\nThe value of one of these quantities at a given age can be output using the Value() attribute of the Star class giving age the Myr and a string with the name of the desired quantity. These can be given either as positional or as keyword arguments. For example, to print Lx at 150 Myr to the screen you can use\n\n```python\nprint(star.Value(150.0,'Lx'))\n```\n\nor\n\n```python\nprint(star.Value(Age=150.0, Quantity='Lx'))\n```\n\nMore simply, the user can use the function with the name of the desired quantity, so the two above lines could be replaced with\n\n```python\nprint(star.Lx(150.0))\n```\n\nInstances of the Star class can be saved using the Save (or save) functions,\n\n```python\nstar.Save()\n```\n\nBy default, the data will be saved into a file called 'star.pickle' but using the user can specify the name of the file using the filename argument in the call to Save(). Saved stars can be loaded using the Load() function.\n\n```python\nstar = mors.Load(\"star.pickle\")\n```\n\n## 3. MODEL DISTRIBUTION AND PERCENTILES\n\nIt is possible when creating an instance of the Star class to specify the initial rotation as a percentile of the model distribution from Johnstone et al. (2020). This model distribution is composed of measured rotation distributions from several clusters with ages of ~150 Myr evolved back to 1 Myr. To get the masses and initial rotation rates of the model cluster, use the function ModelCluster().\n\n```python\nMstar , Omega = ModelCluster()\n```\n\nIf this model cluster is used in any research, please cite the papers listed in Table 1 of Johnstone et al. (2020) for the 150 Myr age bin as the original sources for the rotation measurements (note that the function ModelCluster does not return these measurements, but 1 Myr rotation rates for these stars derived from their measurments using the rotational evolution model of Johnstone et al. 2020). To evolve this cluster, use the Cluster class as described below.\n\nWhen creating an instance of the Star class, use the keyword argument percentile to set the initial rotation rate to a percentile of this distribution. This can either be given as a float or int between 0 and 100 or as a string, with the three options being 'slow', 'medium', and 'fast', corresponding to the 5th, 50th, and 95th percentiles of the rotation distribution. For example\n\n```python\nstar = mors.Star(Mstar=1.0, percentile=5.0)\n```\n\nThis creates a solar mass star with an initial rotation rate equal to the 5th percentile of the rotation distribution at 1 Myr, as determined from our model cluster. This is equivalent to\n\n```python\nstar = mors.Star(Mstar=1.0, percentile='slow')\n```\n\nTo calculate this percentile, the parameter dMstarPer is used and can be set if the user sets up their own parameters as discussed above. This is set by default to 0.1, meaning that all stars within 0.1 Msun of the specified Mstar will be considered.\n\nRegardless of how a star is setup, the percentile in the model distribution is calculated after the evolutionary tracks are calculated and stored in the percentile attribute of the class. It can be seen using\n\n```python\nprint(star.percentile)\n```\n\nIf the user wants to find out the percentile of a given rotation race for a given mass, they can use the the Percentile function, specifying the star's mass and surface rotation rate, either as a rotation velocity in OmegaSun using the Omega (or OmegaEnv) keyword argument, or as a rotation period in days using the Prot keyword argument. For example\n\n```python\nprint(mors.Percentile(Mstar=1.0, Omega=10.0))\n```\n\nThis will print to the screen where in the starting (1 Myr) distribution a solar mass star rotating at 10x the current Sun is, using the model distribution from Johnstone et al. (2020). Or for a star was a 1 day rotation period\n\n```python\nprint(mors.Percentile(Mstar=1.0, Prot=1.0))\n```\n\nAlternatively, the user can specify the percentile and get the corresponding rotation rate\n\n```python\nprint(mors.Percentile(Mstar=1.0, percentile=10.0))\n```\n\nThis prints the rotation rate of the 10th percentile for solar mass stars in OmegaSun. If the user wants to use a different cluster distribution, instead of the 1 Myr model distribution used in Johnstone et al. (2020), the masses and rotation rates of the stars in this distribution can be input. The masses are input as an array of masses in Msun using the MstarDist keyword argument, and the rotation rates can be input either as an array of surface angular velocities in OmegaSun using the OmegaDist keyword argument or as an array of rotation periods in days using the ProtDist keyword argument.\n\n## 4. SETTING SIMULATION PARAMETERS\n\nIn addition to just the masses and initial rotation rates, the basic behavior of the code depends on a large number of parameters all of which have default values and do not need to be changed by the user. These default values cause the code to run the evolutionary model for rotation and XUV emission described in Johnstone et al. (2020) and generally do not need to be changed by the user. However, if the user wishes, these parameters can be changed.\n\nIn general, simulation parameters are held in a dictionary called 'params' within the code, and the user can specify this parameter dictionary when creating a instance of the Star class. When this is not done, the code will use the paramsDefault dictionary created in parameters.py in the source code. To use user specified set of parameters, the user must first generate a parameter dictionary using the NewParams() function.\n\n```python\nmyParams = mors.NewParams()\n```\n\nThis will create a dictionary that is identical to paramsDefault that the user can edit as they want. For example, to change the parameter param1 to 1.5 and param2 to 2.5, use\n\n```python\nmyParams = mors.NewParams()\nmyParams['param1'] = 1.5\nmyParams['param2'] = 2.5\n```\n\nAlternatively, and probably preferrably, this can also be done in the initial call to NewParams using keyword arguments.\n\n```python\nmyParams = mors.NewParams(param1=1.5, param2=2.5)\n```\n\nThis user should then input this as a keyword argument when creating an instance of the Star class.\n\n```python\nstar = mors.Star(Mstar=1.0, Omega=10.0, params=myParams)\n```\n\nTo see a complete list of all parameters that should be set, the user can use the PrintParams() function.\n\n```python\nmors.PrintParams()\n```\n\nOr can simply look into the parameters.py file in the main directory where Mors is installed.\n\nThe user can set the keyword parameter AgesOut when creating a new Star object to a number or a numpy array and this will cause the code to only include these ages and the starting age in the evolutionary tracks. The ages should be given in Myr. For example\n\n```python\nstar = mors.Star(Mstar=1.0, Omega=10.0, AgesOut=100.0)\n```\n\nwill cause the evolutionary tracks to only contain the starting age of 1 Myr and the specified age of 100 Myr. Similarly\n\n```python\nstar = mors.Star(Mstar=1.0, Omega=10.0, AgesOut=np.array([100.0,200.0,300.0,400.0]))\n```\n\nwill cause the evolutionary tracks to contain 1 Myr, and the specified 100, 200, 300, and 400 Myr ages. The simulations will also end at the oldest year in the array. This array should be in ascending order. This is not recommended if the user wants to extract quantities at arbitrary ages along evolutionary tracks, for example using star.Lx(Age), since these functions interpolate between the values and if there are not enough age bins in the evolutionary tracks then these results can be inaccurate. Note that having two many age bins in the AgesOut array, e.g. with AgesOut=np.linspace(1.0,5000.0,10000), will cause the calculations of the evolutionary tracks to be very slow.\n\n## 5. ROTATION AND ACTIVITY QUANTITES\n\nThe code gives the user the ability to use the basic functions for calculating many activity related quantities as functions os stellar properties. For example, the user can calculate XUV luminosities from stellar mass, age, and rotation rates using the Lxuv function. For example,\n\n```python\nLxuv = mors.Lxuv(Mstar=1.0, Age=5000.0, Omega=10.0)\n```\n\nThis gives a dictionary holding X-ray, EUV, and Lyman-alpha luminosities for a 5000 Myr old solar mass star rotating 10 times faster than the Sun. The surface rotation rate can be specified as a rotation velocity using the Omega or OmegaEnv arguments or as a rotation period in days using the Prot argument, e.g.\n\n```python\nLxuv = mors.Lxuv(Mstar=1.0, Age=5000.0, Prot=1.0)\n```\n\nThis is similar to above, but for a star with a rotation period of 1 day.\n\nThe dictionary returned contains the following luminosities, all in erg s<sup>-1</sup>\n\n- Lxuv - 0.517 to 92 nm\n- Lx - 0.517 to 12.4 nm (0.1 to 24 keV)\n- Leuv1 - 10 to 36 nm\n- Leuv2 - 36 to 92 nm\n- Leuv - 10 to 92 nm\n- Lly - Lymann-alpha emission line\n\nThe dictionary also contains surface fluxes (e.g. Fxuv, Fx, Feuv1,...) in erg s<sup>-1</sup> cm<sup>-2</sup> and luminosities normalised to bolometric luminosities (e.g Rxuv, Rx, Reuv1,...).\n\nThe user can also just get the X-ray luminosity as a float using Lx()\n\n```python\nLx = mors.Lx(Mstar=1.0, Age=5000.0, Omega=10.0)\n```\n\nAnd similarly for the EUV and Lymann-alpha luminosities\n\n```python\nLeuv = mors.Leuv(Mstar=1.0, Age=5000.0, Omega=10.0)\nLly = mors.Lly(Mstar=1.0, Age=5000.0, Omega=10.0)\n```\n\nThe function Leuv() also takes the keyword argument 'band' which can be used to specify the band desired (=0 for 10-92 nm; =1 for 10-32 nm; =2 for 32-92 nm).\n\nThe above function calculate an average Lx for a star given its mass, age, and rotation. In reality there is a scatter around these values that appear somewhat random, likely due to variability. This scatter can be described as a log normal probability density function. To calculate this scatter for X-ray luminosity, the user can use the XrayScatter() function.\n\n```python\ndeltaLx = mors.XrayScatter(Lx)\n```\n\nHere, the user should just enter the X-ray luminosity either as a single value or a numpy array and it returns the deltaLx from the equation LxScattered = Lx + deltaLx, where Lx is the value with this scatter not included and LxScattered is the value with it included. The user can also send in Fx or Rx to the function and get deltaFx and deltaRx. Note that these values are random and will be different each time. The width of the random distribution is set by sigmaXray in the parameter file and can be set using the params keyword argument.\n\nTo get scatter values for EUV, Ly-alpha, and all other parameters returned by Lxuv() described above, use XUVScatter() which takes the dictionary returned by Lxuv().\n\n```python\nLxuv = mors.Lxuv(Mstar=1.0, Age=5000.0, Omega=10.0)\ndeltaLxuv = mors.XUVScatter(Lxuv)\n```\n\nThe return value is a dictionary containing delta values for the same quantities in Lxuv.\n\nIf the user wants a more detailed set of parameters for a given star, the ExtendedQuantities() function can be used and in this case, the star's mass, age, and envelope and core rotation rates must be specified.\n\n```python\nquantities = ExtendedQuantities(Mstar=1.0, Age=5000.0, OmegaEnv=10.0, OmegaCore=10.0)\n```\n\nThis returns a larger dictionary with many other quantities, including some basic stellar properties such as radius and moment of inertia, the mass loss rate in the wind, the dipole field strength, and all of the torques acting on the star to influence its rotation. A list of the available parameters can be seen with\n\n```python\nlist(quantities)\n```\n\n## 6. STELLAR EVOLUTION QUANTITIES\n\nThe rotation and activity evolution model requires that various basic stellar properties such as bolometric luminosity, radius, and convective turnover time, can be accessed at all ages for for all masses within the mass range considered (0.1 to 1.25 Msun). These are calculated using the evolutionary tracks fronm Spada et al. (2013) and the functions that do this are available to the user. First import the Mors package\n\n```python\nimport mors\n```\n\nThe stellar mass for a 1.0 Msun star with an age of 1000 Myr can be calculated using\n\n```python\nRstar = mors.Rstar(1.0, 1000.0)\n```\n\nThe functions available are\n\n- Rstar - radius (Rsun)\n- Lbol - bolometric luminosity (Lsun)\n- Teff - effective temperature (K)\n- Itotal - total moment of inertia in (g cm<sup>2</sup>)\n- Icore - core moment of inertia in (g cm<sup>2</sup>)\n- Ienv - envelope moment of inertia in (g cm<sup>2</sup>)\n- Mcore - core mass in (Msun)\n- Menv - envelope mass in (Msun)\n- Rcore - core radius in (Rsun)\n- tau - convective turnover time (days)\n- dItotaldt - rate of change of total moment of inertia (g cm<sup>2</sup> Myr<sup>-1</sup>)\n- dIcoredt - rate of change of core moment of inertia (g cm<sup>2</sup> Myr<sup>-1</sup>)\n- dIenvdt - rate of change of envelope moment of inertia (g cm<sup>2</sup> Myr<sup>-1</sup>)\n- dMcoredt - rate of change of core mass (Msun Myr<sup>-1</sup>)\n- dRcoredt - rate of change of core radius (Rsun Myr<sup>^-1</sup>)\n\nNote that core and envelope have the definitions from the rotation model, so the 'core' is not the hydrogen burning core as it would typically be defined but everything interior to the outer convective zone, and the envelope is the outer convective zone. All of these functions take stellar mass in Msun and age in Myr. Alternatively, the user can call the function Value which takes the same two inputs and then the parameter name as a string. For example\n\n```python\nRstar = mors.Value(1.0, 1000.0, 'Rstar')\n```\n\nwhich is equivalent to the above example.\n\nIn all cases, multiple values for mass and age can be input using lists or numpy arrays and the functions will return numpy arrays holding the results for each input case. For example, if stellar mass is input as a 1D array or list of length 5, the result will be a length 5 numpy array. If both stellar mass and age are input as arrays, the result will be a 2-dimensional array of length len(Mstar)xlen(Age). Additionally, in the call to Value(), the string holding the parameter to calculate for can also be input as a list of strings, in which case the variable retuned will have an additional dimension with values for each of the input quantities.\n\nThe first time one of these functions is called, the code loads all of the evolutionary tracks from the Spada et al. (2013) model. These will be written to the directors in the file SEmodels.pickle in the main directory of the evolutionary models and this file will be used to load the models in the future. This file can be safely deleted if the user wants since this will just cause the code to remake it next time it is needed. The code then does a linear interpolation between mass and age bins to get values at the input masses and ages. This can be time consuming, especially if an interpolation between mass bins is required, which will be the case if the input age is not an integer multiple of 0.05 Msun. The user can load a full evolutionary track for a specific stellar mass using LoadTrack(). For example, to load a track for a 1.02 Msun star, use\n\n```python\nmors.LoadTrack(1.02)\n```\n\nIf a track for that specific mass is already loaded, this will do nothing.\n\n## 7. CLUSTER EVOLUTION CALCULATIONS\n\nThe code allows the user to calculate the evolution of stellar clusters in addition to single stars. This is done using the Cluster class. An instance of the Cluster class can be created in much the same way as an instance of the Star class using the same input keyword arguments. The only difference is that the masses and rotation rates of the stars should be given as arrays or lists\n\n```python\nMstar = np.array([1.0, 0.5, 0.75])\nOmega = np.array([ 10.0, 10.0, 10.0])\ncluster = mors.Cluster(Mstar=Mstar, Omega=Omega)\n```\n\nThis will create a cluster composed of three stars and immediately calculate evolutionary tracks for each. To see the progress of these calculations printed to the screen, use the verbose keyword argument\n\n```python\ncluster = mors.Cluster(Mstar=Mstar, Omega=Omega, verbose=True)\n```\n\nAs in the Star class, it is possible to specify the Age keyword argument. If this is not specified, the code will assume the Omega values are starting (1 Myr) rotation rates. If it is specified, the code will fit the rotation tracks such that they pass through the specified rotation rates at the speficied ages. If Age is specified as a single value (in Myr), it will be assumed that all stars have that age, and if it is specified as a numpy array then the array should have the same lengths as Mstar and Omega and the ages will be assumed individually for each star. As with the Star class, it is possible to input simulation parameters using the params keyword argument (see above).\n\nAs in the Star class, an instance of the Cluster class can be saved using the Save (or save) function\n\n```python\ncluster.Save()\n```\n\nBy default, the data will be saved into a file called 'cluster.pickle' but using the user can specify the name o the file using the filename argument in the call to Save(). Saved clusters can be loaded using the Load() function.\n\n```python\ncluster = mors.Load(\"cluster.pickle\")\n```\n\nThis is advisable since the evolutionary tracks for clusters can take a lot of time to calculate if there are lots of stars.\n\nThe Star class instances for each star in the cluster is held in the stars list, which is an attribute of this class. To plot Lx tracks for each star for example, the user can use\n\n```python\nplt.plot(cluster.stars[0].AgeTrack, cluster.stars[0].LxTrack)\nplt.plot(cluster.stars[1].AgeTrack, cluster.stars[1].LxTrack)\nplt.plot(cluster.stars[2].AgeTrack, cluster.stars[2].LxTrack)\n```\n\nAlternatively, each star is an attribute of the class instance and has the name 'star' followed by its place in the list (starting at zero), so the above can be replaced with\n\n```python\nplt.plot(cluster.stars0.AgeTrack, cluster.stars0.LxTrack)\nplt.plot(cluster.stars1.AgeTrack, cluster.stars1.LxTrack)\nplt.plot(cluster.stars2.AgeTrack, cluster.stars2.LxTrack)\n```\n\nTo get values for each star at a given age of a given parameter, the user can use the Values() function, specifying the age in Myr and a string for the quantity to retrieve. For example,\n\n```python\nLx = cluster.Values(Age=100.0, Quantity='Lx')\n```\n\nThis gives an array with Lx for each star in the cluster. Alternatively, as with the Star class, each quantity can be specified using its own function and the above is equivalent to.\n\n```python\nLx = cluster.Lx(100.0)\n```\n\nSo to plot the Lx distribution for a cluster at 100 Myr, the user can use\n\n```python\nplt.scatter(cluster.Mstar, cluster.Lx(100.0))\n```\n\nIn Johnstone et al. (2020), many of the results are based on a composite cluster that is often referred to in the paper as the model cluster. This is composed of measured rotation distributions from several clusters with ages of ~150 Myr evolved back to 1 Myr.\nTo get the masses and initial rotation rates of the model cluster, use the function ModelCluster().\n\n```python\nMstar , Omega = ModelCluster()\n```\n\nIf this model cluster is used in any research, please cite the papers listed in Table 1 of Johnstone et al. (2020) for the 150 Myr age bin as the original sources for the rotation measurements (note that the function ModelCluster does not return these measurements, but 1 Myr rotation rates for these stars derived from their measurments using the rotational evolution model of Johnstone et al. 2020). This cluster can then be evolved in the usual way\n\n```python\nMstar , Omega = ModelCluster()\ncluster = mors.Cluster(Mstar=Mstar, Omega=Omega)\n```\n\nThe Cluster class also has a function that allows the user to find where in the distribution a star with a given mass and surface rotation rate rate is at a given age. This uses the Percentile function discussed above applied to the rotation distribution of this cluster at the specified age.\n\n## 8. HABITABLE ZONE BOUNDARIES\n\nUsing the formulae of Kopparapu et al. (2013) and the luminosities and effective temperatures from the stellar models of Spada et al. (2013), the user can calculate the orbital distances of the habitable zone boundaries as a function of stellar mass and age. Please cite these two papers if using the output of this function. The HZ boundaries are calculated using the aOrbHZ function.\n\n```python\naOrbHZ = mors.aOrbHZ(Mstar=1.0)\n```\n\nIn this case, the function returns a dictionary holding the orbital distances in AU in a dictionary. The six values in the dictionary are 'RecentVenus', 'RunawayGreenhouse', 'MoistGreenhouse', 'MaximumGreenhouse', 'EarlyMars', and 'HZ'. While the first five are obvious and correspond to the boundaries in Kopparapu et al. (2013), the final one is defined in Johnstone et al. (2020) as the average of the runaway greenhouse and moist greenhouse orbital distances. For example, to see these values\n\n```python\nprint(aOrbHZ['RecentVenus'])\nprint(aOrbHZ['RunawayGreenhouse'])\nprint(aOrbHZ['MoistGreenhouse'])\nprint(aOrbHZ['MaximumGreenhouse'])\nprint(aOrbHZ['EarlyMars'])\nprint(aOrbHZ['HZ'])\n```\n\nMstar can be input as a numpy array in which case the dictionary will contain arrays with values for each mass. By default the orbital distances are calculated assuming stellar parameters at 5000 Myr. The user can also set the age in Myr using the Age keyword argument\n\n```python\naOrbHZ = mors.aOrbHZ(Mstar=1.0, Age=1000.0)\n```\n\n## 9. ACTIVITY LIFETIMES\n\nThe code contains functions that calculate how long stars remain above certain acitivty thresholds. Firstly, the function ActivityLifetime() takes an evolutionary track and returns when the value of the track goes below a certain threshold. For example\n\n```python\nAgeThreshold = mors.ActivityLifetime(Age=star.AgeTrack, Track=star.LxTrack, Threshold=1.0e28)\n```\n\nThis will tell us when the star's Lx dropped below 10<sup>28</sup> erg s<sup>-1</sup>. If the star crosses this threshold multiple times, only the final time will be returned. If it never goes below this threshold then the final age in the track will be returned and if it is never above this threshold then 0.0 will be returned. If the user wants to set a maximum age so that the code only looks for crossings of the threshold below this age then this can be done using the AgeMax keyword argument\n\nMore recommended though is to use the function of the same name in the Star class, where the quantity of interest should be specified as a string.\n\n```python\nAgeThreshold = star.ActivityLifetime(Quantity='Lx', Threshold=1.0e28)\n```\n\nThis does the same thing. Valid options for Quantity are 'Lx', 'Fx', 'Rx', 'FxHZ', 'Leuv1', 'Feuv1', 'Reuv1', 'Feuv1HZ', 'Leuv2', 'Feuv2', 'Reuv2', 'Feuv2HZ', 'Leuv', 'Feuv', 'Reuv', 'FeuvHZ', 'Lly', 'Fly', 'Rly', and 'FlyHZ'. It is also possible here to specify AgeMax. If the user wants to know how long the star remained saturated, Threshold can be given with the string 'sat'.\n\n```python\nAgeSaturated = star.ActivityLifetime(Quantity='Lx', Threshold='sat')\n```\n\nNote that when doing this, the value of Quantity should not influence the return value since all XUV quantities saturate at the same time, though it still must be set to a valid option.\n\nThe Cluster class also contains this function and is called in the exact same way, returning this time the values for each star in the cluster as a numpy array.\n\n```python\nAgeThreshold = cluster.ActivityLifetime(Quantity='Lx', Threshold=1.0e28)\n```\n## 10. BARAFFE STELLAR EVOLUTION QUANTITIES\n\nThe Forming Worlds MORS package also provides access to stellar evolution quantities according to the Baraffe model (Baraffe et al., 2002). The evolution track for a given star mass Mstar, between 0.01 and 1.4 Msun, can be loaded into memory with the command\n\n```python\nbaraffe = mors.BaraffeTrack(Mstar)\n```\nThe command performs mass interpolation (if needed) and time interpolation into a fine grid of 5e4 points. For a given time, the user can then access to the luminosity, the solar constant and the stellar radius with the following functions\n\n- Stellar radius in Rsun, time in yr\n```\nRstar = baraffe.BaraffeStellarRadius(time)\n```\n- Bolometric flux in Lsun, time in yr\n```\nLbol = baraffe.BaraffeLuminosity(time)\n```\n- Flux scaled by the star-planet distance in W m<sup>-2</sup>, time in yr, distance in AU\n```\nFlux = baraffe.BaraffeSolarConstant(time, distance)\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Stellar rotation and activity evolution model",
"version": "25.2.26",
"project_urls": {
"homepage": "https://github.com/FormingWorlds/MORS"
},
"split_keywords": [
"exoplanet",
" stellar evolution"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "98943b16bb14bd13e57d71c3295009587c13353cc72836531cc336e280211a2f",
"md5": "314813e9289aec9d0d466eb2f4cb9c3d",
"sha256": "ac257a7e2a5222405511d411e37577829573a7ffdf23dc5d04a80b4cfdb9c3f7"
},
"downloads": -1,
"filename": "fwl_mors-25.2.26-py3-none-any.whl",
"has_sig": false,
"md5_digest": "314813e9289aec9d0d466eb2f4cb9c3d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 78076,
"upload_time": "2025-02-27T11:42:42",
"upload_time_iso_8601": "2025-02-27T11:42:42.437754Z",
"url": "https://files.pythonhosted.org/packages/98/94/3b16bb14bd13e57d71c3295009587c13353cc72836531cc336e280211a2f/fwl_mors-25.2.26-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "967259185538e65ba6ef5f7e6f4f08274ba72ab922fb41ad1a66d427ba29d8f2",
"md5": "6fd977ebf41057156c6240d72c5d0616",
"sha256": "9eabe2ca2d53c55031b282c6283f5c0fdeead1106d8a918acb77eb3d58cf1bfb"
},
"downloads": -1,
"filename": "fwl_mors-25.2.26.tar.gz",
"has_sig": false,
"md5_digest": "6fd977ebf41057156c6240d72c5d0616",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 84276,
"upload_time": "2025-02-27T11:42:44",
"upload_time_iso_8601": "2025-02-27T11:42:44.639940Z",
"url": "https://files.pythonhosted.org/packages/96/72/59185538e65ba6ef5f7e6f4f08274ba72ab922fb41ad1a66d427ba29d8f2/fwl_mors-25.2.26.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-27 11:42:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FormingWorlds",
"github_project": "MORS",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "osfclient",
"specs": []
},
{
"name": "platformdirs",
"specs": []
},
{
"name": "scipy",
"specs": []
}
],
"lcname": "fwl-mors"
}
JSON
