Density docs #918
Density docs #918
Conversation
Codecov Report
@@ Coverage Diff @@
## master #918 +/- ##
==========================================
+ Coverage 66.41% 66.42% +0.01%
==========================================
Files 84 84
Lines 5991 5993 +2
==========================================
+ Hits 3979 3981 +2
Misses 2012 2012
Continue to review full report at Codecov.
|
…re outside of model velocity range.
…alues for v_inner_boundary and v_outer_boundar
…tside model velocity range.
docs/examples/densitycust.rst
Outdated
| Inner Boundary | ||
| ============== | ||
|
|
||
| The first velocity-density pair in a custom density file (given by index 0) specifies the velocity of the inner boundary approximation to the photosphere. The density associated with this velocity is the density of the optically thick inner region, which does not affect TARDIS spectra. Therefore, the first density (5.4869692e-10 in the example above) can be replaced by a placeholder value. The user can choose to both specify a custom density fileAND specify v_inner_boundary and v_outer_boundary in the configuration YAML file for a TARDIS run. In this case, v_inner_boundary is ignored if it is less than the smallest velocity listed in the custom density file. Likewise, v_outer_boundary is ignored if it is larger than the largest velocity in the custom density file. If either of the YAML specified boundary velocities fall within the velocity range specified in the custom density file, then the boundary velocity is set equal to the number in the configuration YAML file. This has the effect of splitting a cell in the custom density file into two parts, a region within the boundary and a region outside the boundary. |
There was a problem hiding this comment.
take out optically thick maybe
There was a problem hiding this comment.
specifies to v=0 (which is r=0). If specifying a v_inner below the inner boundary of the model - it will make a new shell with the given density.
There was a problem hiding this comment.
We've decided not to implement this functionality. The user must change their model if they want to specify a v_inner_boundary lower than the lowest shell velocity, and similarly for v_outer_boundary.
tardis/model/base.py
Outdated
| @@ -220,20 +220,23 @@ def no_of_raw_shells(self): | |||
| def v_boundary_inner(self): | |||
| if self._v_boundary_inner is None: | |||
| return self.raw_velocity[0] | |||
| if self._v_boundary_inner < 0: | |||
There was a problem hiding this comment.
maybe you want to specify 0 * u.km/u.s
tardis/model/base.py
Outdated
| 'the model range.') | ||
| if value <= self.raw_velocity[0]: | ||
| value = None | ||
| if value > 0: |
tardis/model/base.py
Outdated
| @@ -242,20 +245,23 @@ def v_boundary_inner(self, value): | |||
| def v_boundary_outer(self): | |||
| if self._v_boundary_outer is None: | |||
| return self.raw_velocity[-1] | |||
| if self._v_boundary_outer < 0: | |||
tardis/model/base.py
Outdated
| raise ValueError('v_boundary_inner is outside of ' | ||
| 'the model range.') | ||
| if value < self.raw_velocity[0]: | ||
| raise ValueError('v_boundary_inner is outside of the model range.') |
There was a problem hiding this comment.
is lower than the lowest shell in the model
|
Looks very good - what happened to the notebook? |
| distance: 8.32 Mpc | ||
|
|
||
| # standard atomic data base; get it from the tardis-refdata repository | ||
| atom_data: /home/mew488/Research/TARDIS/tardis-refdata/atom_data/kurucz_cd23_chianti_H_He.h5 |
There was a problem hiding this comment.
now you can just write kurucz_cd23_chianti_H_He.h5
Added warnings and updated documentation relating to Issue #908. Warnings alert the user when the boundary velocities specified in the config file are ignored. Explanation of this behavior is added to the custom density documentation.