the result will be inserted in a `Description` section of the corresponding entry of the documentation
the result will be inserted in a `Description` section of the corresponding entry of the documentation.
.. note::
Please note that if you need sub-sections in the description section,
you should use the dot :bash:`..........` to underline sub-titles.
* a dictionary :bash:`input_arguments`: this dictionary is both used to define default values and document arguments
that are needed in the configuration file; for each entry, you can add a :bash:`"doc"` entry, including a string describing the corresponding argument:
that are needed in the configuration file; for each entry, you can add a :bash:`"doc"` entry,
including a string describing the corresponding argument:
.. code-block:: python
...
...
@@ -87,13 +101,47 @@ To allow this feature to work properly, the :bash:`__init__.py` file of the plug
}
}
Some plugins may require sub-paragraphs to be properly defined. This can be done as follows:
.. code-block:: python
input_arguments = {
"some_argument": {
"doc": "somedescription",
"default": None if mandatory else a default value,
"accepted": a python type that the argument should fit
},
"some_subparagraph": {
"doc": "Documentationoftheparagraph",
"default": None (must be None here),
"optional": True or False,
"structure": {
"sub-arguments1": {
"doc": "somedescription",
"default": None if mandatory else a default value,
"accepted": a python type that the argument should fit
},
"sub-arguments2": {
"doc": "somedescription",
"default": None if mandatory else a default value,
"accepted": a python type that the argument should fit
},
"some_subsubparagraph": {
...
}
}
}
}
Proposing tutorials
-------------------
Tutorials are critical for new users and developers to start working with the CIF efficiently.
They should encompass as many situations as possible.
Experienced users/developers are encouraged to share their experience and explain how to tackle some specific difficulties they met in using the system.
Experienced users/developers are encouraged to share their experience
and explain how to tackle some specific difficulties they met in using the system.
@@ -13,9 +13,20 @@ Welcome to the Community Inversion Framework!
The Community Inversion Framework is governed by the CeCILL-C license under French law.
Please consult the reference text `here <https://cecill.info/licences/Licence_CeCILL-C_V1-en.html>`__ for further detail.
The license grants full rights for the users to use, modify and redistribute the original version of the CIF,
conditional to the obligation to make their modifications available to the community and to properly acknowledge the original authors of the code.
conditional to the obligation to make their modifications available to the community
and to properly acknowledge the original authors of the code.
.. admonition:: Use, aknowledgement and citation
The Community Inversion Framework has been designed by a community of scientists who agreed to openly share their developments.
The maintenance and further developments are made possible through continued efforts by the core team of developper,
with the support of their respective funding agencies.
Any use of the Community Inversion Framework should then be fairly acknowledged.
Users are required to establish contact with `the team of developers <help@community-inversion.eu>`__ to determine an appropriate level of acknowledgement
