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

Expand the README.md file #6

Open
6 tasks
livoire13 opened this issue Mar 5, 2025 · 0 comments
Open
6 tasks

Expand the README.md file #6

livoire13 opened this issue Mar 5, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@livoire13
Copy link
Collaborator

livoire13 commented Mar 5, 2025

  • Make a distinction between required python packages and optional ones
  • Installation using conda should 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 data directory and its sub-directories; explain how the user may set the FEMTOSCOPE_BASE_DIR environment variable when the working script and the data directory 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 femtoscope to something like femtoscope_env to avoid confusion
@livoire13 livoire13 added the documentation Improvements or additions to documentation label Mar 5, 2025
@livoire13 livoire13 self-assigned this Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant