Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Observers Library #40

Merged
merged 35 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
1705a6e
zarr and observers folders renamed
yoctoyotta1024 Apr 9, 2024
88b253e
#includes and cmake targets renamed
yoctoyotta1024 Apr 9, 2024
cfb0666
draft rst files for observers
yoctoyotta1024 Apr 9, 2024
4f97014
todo notes added
yoctoyotta1024 Apr 9, 2024
3eb6228
docs(streamoutobserver): for stream out observer
yoctoyotta1024 Apr 9, 2024
96a6734
docs(observers): runstats docs
yoctoyotta1024 Apr 9, 2024
14ee189
chore: delete TODOs
yoctoyotta1024 Apr 9, 2024
211bb4c
refactor(zarr): docstrings with /* */ not ///<
yoctoyotta1024 Apr 9, 2024
e87357f
docs(observers): docstrings and rst file for gbxindex observer
yoctoyotta1024 Apr 9, 2024
cabd8cc
docs(observers): docstrings and rst file for time observer
yoctoyotta1024 Apr 9, 2024
fc78a1f
chore: format wiht clang-format and reword note: as _note_:
yoctoyotta1024 Apr 9, 2024
e6662fb
docs(observers): docstrings and rst file for totnsupers observer
yoctoyotta1024 Apr 9, 2024
c885ac1
docs(observers): more docstrings and rst for write_to_dataset_observer
yoctoyotta1024 Apr 11, 2024
b41588b
docs(observers): docstrings for parallel_write_data structs
yoctoyotta1024 Apr 11, 2024
ad19212
docs(observers): docstrings for parallel_write_data structs
yoctoyotta1024 Apr 11, 2024
b25f76c
docs(observers): docstrings and rst file for paralle_write_data
yoctoyotta1024 Apr 11, 2024
fb50e4e
refactor(observers): formatting
yoctoyotta1024 Apr 11, 2024
a960089
docs(observers): docstrings and rst file for collect_data_for_dataset
yoctoyotta1024 Apr 11, 2024
c5655f3
docs(observers): docstrings and rst file for generic_collect_data
yoctoyotta1024 Apr 11, 2024
e9782f7
chore: todos and formatting
yoctoyotta1024 Apr 11, 2024
eb15834
docs(observers): docstrings and rst file for massmoments_observer
yoctoyotta1024 Apr 11, 2024
9305e4e
docs(observers): docstrings and rst file for Nsupers observer
yoctoyotta1024 Apr 11, 2024
13f9580
docs(observers): docstrings and rst file for Nsupers observer
yoctoyotta1024 Apr 11, 2024
5a83ae2
docs(observers): docstrings and rst file for state observer
yoctoyotta1024 Apr 11, 2024
91e13a5
docs(observers): docstrings and rst file for state observer
yoctoyotta1024 Apr 11, 2024
db6bab3
docs(observers): docstrings and rst file for wind velocities observer
yoctoyotta1024 Apr 11, 2024
2aca07e
docs(observers): docstrings and rst file for wind velocities and ther…
yoctoyotta1024 Apr 11, 2024
881cdd9
docs(observers): docstrings and rst file for wind velocities and ther…
yoctoyotta1024 Apr 11, 2024
8ed7ed9
docs(observers): superdrops docstrings wIP
yoctoyotta1024 Apr 11, 2024
f3de5ac
docs(observers): superdrops docstrings wIP
yoctoyotta1024 Apr 11, 2024
03f7235
docs(observers): superdrops docstrings and rst file
yoctoyotta1024 Apr 11, 2024
057a817
docs(observers): docs for observers complete
yoctoyotta1024 Apr 11, 2024
8bc81bc
fix(observers): add missing public declaration back
yoctoyotta1024 Apr 11, 2024
aa89802
refactir(eurec4a1d): renaming of observers and zarr libraries in eure…
yoctoyotta1024 Apr 11, 2024
cc7f39a
refactor(eurec4a1d): renaming of observers and zarr libraries in eure…
yoctoyotta1024 Apr 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/doxygen/doxygen.dox
Original file line number Diff line number Diff line change
Expand Up @@ -949,7 +949,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ../libs/runcleo/ ../libs/superdrops/ ../libs/zarr2/ ../libs/observers2/
INPUT = ../libs/runcleo/ ../libs/superdrops/ ../libs/zarr/ ../libs/observers/

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Author: Clara Bayley (CB)
Additional Contributors:
-----
Last Modified: Wednesday 27th March 2024
Last Modified: Tuesday 9th April 2024
Modified By: CB
-----
License: BSD 3-Clause "New" or "Revised" License
Expand Down Expand Up @@ -76,8 +76,8 @@
breathe_projects = {
"runcleo" : "../build/doxygen/xml/",
"superdrops" : "../build/doxygen/xml/",
"zarr2" : "../build/doxygen/xml/",
"observers2" : "../build/doxygen/xml/",
"zarr" : "../build/doxygen/xml/",
"observers" : "../build/doxygen/xml/",
}

breathe_default_project = 'proj'
Expand Down
4 changes: 2 additions & 2 deletions docs/source/cxx/cxx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ a SDM coupled to a Dynamics Solver.

runcleo/runcleomod
superdrops/superdropsmod
zarr2/zarr2mod
observers2/observers2mod
zarr/zarrmod
observers/observersmod

Indices and tables
------------------
Expand Down
25 changes: 25 additions & 0 deletions docs/source/cxx/observers/collect_data_for_dataset.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Collect Data For Dataset
========================

Header file: ``<libs/observers/collect_data_for_dataset.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/collect_data_for_dataset.hpp>`_

.. doxygenconcept:: CollectDataForDataset
:project: observers

.. doxygenstruct:: CombinedCollectDataForDataset
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenfunction:: operator>>(const CollectData1 a, const CollectData2 b)
:project: observers

.. doxygenstruct:: NullCollectDataForDataset
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:
19 changes: 19 additions & 0 deletions docs/source/cxx/observers/gbxindex_observer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Gbxindex Observer
=================

Header file: ``<libs/observers/gbxindex_observer.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/gbxindex_observer.hpp>`_

.. doxygenstruct:: GbxIndexFunctor
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenclass:: GbxindexObserver
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:
19 changes: 19 additions & 0 deletions docs/source/cxx/observers/generic_collect_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Generic Collect Data
====================

Header file: ``<libs/observers/generic_collect_data.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/generic_collect_data.hpp>`_

.. doxygenstruct:: XarrayAndViews
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenclass:: GenericCollectData
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:
44 changes: 44 additions & 0 deletions docs/source/cxx/observers/massmoments_observer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Massmoments Observer
====================

Header file: ``<libs/observers/massmoments_observer.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/massmoments_observer.hpp>`_

.. doxygenstruct:: MassMomentsFunc
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenstruct:: RaindropsMassMomentsFunc
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenstruct:: CollectMassMoments
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenfunction:: create_massmoment_xarray
:project: observers

.. doxygenfunction:: create_massmom0_xarray
:project: observers

.. doxygenfunction::create_massmom1_xarray
:project: observers

.. doxygenfunction:: create_massmom2_xarray
:project: observers

.. doxygenfunction::MassMomentsObserver
:project: observers

.. doxygenfunction::MassMomentsRaindropsObserver
:project: observers
18 changes: 18 additions & 0 deletions docs/source/cxx/observers/nsupers_observer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Nsupers Observer
================

Header file: ``<libs/observers/nsupers_observer.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/nsupers_observer.hpp>`_

.. doxygenstruct:: NsupersFunc
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenfunction:: CollectNsupers
:project: observers

.. doxygenfunction:: NsupersObserver
:project: observers
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
Observers
=========

Header file: ``<libs/observers2/observers.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers2/observers.hpp>`_
Header file: ``<libs/observers/observers.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/observers.hpp>`_

.. doxygenconcept:: Observer
:project: observers2
:project: observers

.. doxygenstruct:: CombinedObserver
:project: observers2
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenfunction:: operator>>(const Observer auto obs1, const Observer auto obs2)
:project: observers2
:project: observers

.. doxygenstruct:: NullObserver
:project: observers2
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenconcept:: ObsFuncs
:project: observers2
:project: observers

.. doxygenstruct:: ConstTstepObserver
:project: observers2
:project: observers
:private-members:
:protected-members:
:members:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,18 @@ e.g. to a dataset or to a computer screen.
:caption: Contents:

observers
streamout_observer
runstats_observer.rst
write_to_dataset_observer.rst
parallel_write_data.rst
collect_data_for_dataset.rst
generic_collect_data.rst
time_observer.rst
gbxindex_observer.rst
superdrops_observer.rst
nsupers_observer.rst
totnsupers_observer.rst
state_observer.rst
thermo_observer.rst
windvel_observer.rst
massmoments_observer.rst
36 changes: 36 additions & 0 deletions docs/source/cxx/observers/parallel_write_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Parallel Write Data
===================

Header file: ``<libs/observers/parallel_write_data.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/parallel_write_data.hpp>`_

.. doxygenstruct:: ParallelGridboxesRangePolicyFunc
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenstruct:: ParallelGridboxesTeamPolicyFunc
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenclass:: ParallelWriteGridboxes
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenconcept:: CollectRaggedCount
:project: observers

.. doxygenclass:: ParallelWriteSupers
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:
19 changes: 19 additions & 0 deletions docs/source/cxx/observers/runstats_observer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
RunStatsObserver
================

Header file: ``<libs/observers/runstats_observer.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/runstats_observer.hpp>`_

.. doxygenstruct:: RunStats
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:

.. doxygenclass:: RunStatsObserver
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:
8 changes: 8 additions & 0 deletions docs/source/cxx/observers/state_observer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
State Observer
==============

Header file: ``<libs/observers/state_observer.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/state_observer.hpp>`_

.. doxygenfunction:: StateObserver
:project: observers
12 changes: 12 additions & 0 deletions docs/source/cxx/observers/streamout_observer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
StreamOut Observer
==================

Header file: ``<libs/observers/streamout_observer.hpp>``
`[source] <https://github.com/yoctoyotta1024/CLEO/blob/main/libs/observers/streamout_observer.hpp>`_

.. doxygenstruct:: StreamOutObserver
:project: observers
:private-members:
:protected-members:
:members:
:undoc-members:
Loading
Loading