DOCUMENTATION TODO LIST

[erwanp]

List of small documentation improvements

Just comment to report a broken link, or suggest a documentation improvement! If it's a big make, consider filling a New Issue.

New contributors: you may want to pick one of these items and implement it. That's a good start! For that, it is recommended that you first open a New Issue dedicated to the chosen item!

New users: if a RADIS feature is not clear, comment here and we'll improve the documentation at some point. You can also mention in on the community chat:

In the documentation

• Add mini galleries for api documentation Add (more) mini galleries of examples in Documentation #136 (started, we can still add more !)
• docs: rename "spectral quantities" (radiance, transmittance, abscoeff, etc.) to "spectral arrays" consistently throughout the code so we don't confuse them with "dimensioned quantities" / "units"? (up for discussion) Changed 'Spectral Quantity' to 'Spectral Array' at every occurrence #236
• generalize the use of "opacity", which is according to ISO 80000-7:2019 the same term as our "abscoeff", and more widely used in astrophysics.
• resample : add examples
• Add more examples in Line_survey. Also the link to the online website https://radis.readthedocs.io/en/latest/tools/line_survey.html doesnt work. Reported by @CorentinGrimaldi
• The links under "see also" (at the end of the page) don't work. here. Reported by @adityabharadwaj198
• update Badges in main readme : update Binder to RADIS-Lab, remove gitter.
• add examples to DatabankLoader.load_databank
• in the SpectrumObject documentatino, add a section explicitely named "Save to disk"
• autoformat docstrings to Numpy convention in a more compact way (removing all extra lines). See docformatter. Maybe add pydocstyle in pre-commit
• contributor badge on README.rst has wrong target (to stargazers)
• add Sidebars Twitter/GitHub/maybe RADIS-app/Lab buttons similar to biotite-python
• add Planck's law formula (for wavelengths and wavenumbers) in docstrings of sPlanck and plot_blackbody
• make Spectra Database clickable in Radis-flow-chart
• fix GPU Doc
• add example with fit_spectrum method of SpecDatabase (rename it best_match_spectrum ? )

Example gallery

• Add more example galleries Add (more) mini galleries of examples in Documentation #136
• Add example for fetch_hitemp (plot the linestrengths of CO?)
• Add an example showing How to use Custom Spectroscopic constants (write your own ElectronicState object, etc. )

Others

• Compute interactive list of infrared spectra for all HITRAN molecules (similar to HITRAN-spectra ) but with plotly)

[CorentinGrimaldi]

Add more examples in Line_survey. Also the link to the online website https://radis.readthedocs.io/en/latest/tools/line_survey.html doesnt work.

[adityabharadwaj198]

The links under "see also" (at the end of the page) don't work.
here

[erwanp]

Added :

generalize the use of "opacity", which is according to ISO 80000-7:2019 the same term as our "abscoeff", and more widely used in astrophysics.

[anandxkumar]

In the LBL documentation documentation this link doesn't exist (Radis Flow Chart) .

[erwanp]

Thank you @anandxkumar for reporting. The link is now https://radis.readthedocs.io/en/latest/_images/RADIS_flow_chart.svg . Do you want to fix it directly ?

[anandxkumar]

Hello @erwanp, in the Features Use Cases section , the comparison image of 2 spectra is not rendering and we are getting the alternate text https://radis.readthedocs.io/en/latest/_images/cdsd4000_vs_hitemp_3409K.svg, should I create a new pull request solving both issues by changing .. image:: spectrum/cdsd4000_vs_hitemp_3409K.* to image link in features.rst and similar for the LBL documentation?

[erwanp]

Hello. The cdsd4000_vs_hitemp_3409K image you're referring to also appears in the main index : https://radis.readthedocs.io/en/latest/index.html . Here, it renders properly. You may use the code there to fix it.

However, it does not appear in the pdf documentation . You may want to investigate why.

Images rendering are a bit of a pain in Readthedocs. If you want to work on this, you should try to build the docs locally. See gendocs.sh

[anandxkumar]

Made a pull request for the same. Not sure why the images weren't rendering. The exact same code runs fine on 1 file and not on the other(tried replicating 1 working .rst file into the other to see if it work but negative). It worked fine when I loaded the image link. One suggestion, can we add a documentation for contributing to the radis document so that if anyone wants to contribute to it as a Good First Issue can refer to it( like installing the necessary sphinx library, running ./gendocs.sh, checking docs/_build/html/index.html to see the changes) ?

Also can you help me with one issue I'm facing due to the documentation thing. After running ./gendocs.sh, whenever I run pytest, in the beginning I get this error

platform linux -- Python 3.6.13, pytest-6.2.2, py-1.10.0, pluggy-0.13.1
rootdir: /home/pipebomb/radis, configfile: setup.cfg
collected 168 items / 13 deselected / 155 selected                             

docs/_build/html/_sources/dev/test.rst.txt F                             [  0%]

Following is the traceback -

Traceback

____________________________ [doctest] test.rst.txt ____________________________
126
127 Load a line database file ::
128
129 from radis.test.utils import getTestFile
130 from radis.io.hitran import hit2df
131 df = hit2df(getTestFile("hitran_CO_fragment.par"))
132
133 print(df) # replace with your test code
134
135 >>> Out:
UNEXPECTED EXCEPTION: SyntaxError('invalid syntax', ('', 1, 5, 'Out:\n'))
Traceback (most recent call last):
File "/home/pipebomb/anaconda3/envs/radis-env/lib/python3.6/doctest.py", line 1330, in __run
compileflags, 1), test.globs)
File "", line 1
Out:
^
SyntaxError: invalid syntax
/home/pipebomb/radis/docs/_build/html/_sources/dev/test.rst.txt:135: UnexpectedException

But the same passed on Travis CI without any issue. I deleted the .radis, .radisdb but that isn't the issue. Not sure what to do to resolve this. Thanks!