TNO Intern

Commit 8477ecf4 authored by Arjo Segers's avatar Arjo Segers
Browse files

Updated documentation and reformated files.

parent df1e47bf

Makefile

+1 −1
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ help: 
# re-format python files,

# use local maximum line-length convention ..

black:

	black --line-length=99 py doc/source/conf.py

	black --line-length=99 src doc/source/conf.py



# generate documentation:

docu:

doc/source/conf.py

+3 −1
Original line number Diff line number Diff line
@@ -12,6 +12,7 @@ 
#

import os

import sys



#

sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src")))

sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src", "utopya")))
@@ -35,6 +36,7 @@ if not os.path.isfile(ppfile): 
else:

    # modules:

    import toml



    # open file:

    with open(ppfile, "r") as f:

        config = toml.load(f)

src/cso/__init__.py

+1 −0
Original line number Diff line number Diff line
@@ -109,6 +109,7 @@ and are defined according to the following hierchy: 


# store version number:

from importlib import metadata



__version__ = metadata.version(__package__)



# import entities from sub-modules:

src/cso/scripts/cli.py

+1 −0
Original line number Diff line number Diff line
@@ -32,6 +32,7 @@ def callback( 
):

    """🛰️  CAMS Satellite Operator (CSO) Command Line Interface"""





@main.command()

def run(rc_file: str = typer.Argument(..., help="Provide .rc file")):

    """Run cso based on settings provided in .rc file (e.g., cso run config/tutorial/tutorial.rc)"""

src/utopya/__init__.py

+10 −16
Original line number Diff line number Diff line
@@ -67,21 +67,15 @@ Utopya modules 


Actual implementations can be found in submodules:



.. The following are names of '.rst' files in the 'doc/sources' directory ;

   this ensures that each sub-module is given a seperate page in the documentation.



.. toctree::

   :maxdepth: 1



   pymod-utopya_base

   pymod-utopya_rc

   pymod-utopya_jobscript

   pymod-utopya_jobtree

   pymod-utopya_runscript

   pymod-utopya_tools

   pymod-utopya_build

   pymod-utopya_post

   pymod-utopya_index

* :py:mod:`utopya.utopya_base`

* :py:mod:`utopya.utopya_rc`

* :py:mod:`utopya.utopya_jobscript`

* :py:mod:`utopya.utopya_jobtree`

* :py:mod:`utopya.utopya_runscript`

* :py:mod:`utopya.utopya_tools`

* :py:mod:`utopya.utopya_build`

* :py:mod:`utopya.utopya_post`

* :py:mod:`utopya.utopya_index`





.. Label, use :ref:`text <label>` for reference
@@ -109,7 +103,7 @@ and are defined according to the following hierchy: 
    * :py:class:`.UtopyaCompilerSettings`



      * :py:class:`.UtopyaCompilerSettingsFortran`

      * :py:class:`.UtopyaCompilerSettingsF2py`

      * :py:class:`.UtopyaCompilerSettingsF2Py`



    * :py:class:`.UtopyaLibSettings`

    * :py:class:`.UtopyaDependencies`