-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
- Make a distinction between required python packages and optional ones
- Installation using
condashould use the conda-forge channel - Make clearer what the software actually does and why it is useful (header of the readme file)
- In the 'Getting started' section, provide additional information on the tree-structure of the
datadirectory and its sub-directories; explain how the user may set theFEMTOSCOPE_BASE_DIRenvironment variable when the working script and thedatadirectory are not located in the same place - Briefly comment the UML diagram: general data flow, mesh creation, how femtoscope builds on sfepy, the ifem technique, etc.
- In the 'Development mode' section, replace the name of the conda environment from
femtoscopeto something likefemtoscope_envto avoid confusion
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation