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

docs: describe ZARP outputs and how to use/explore them #165

Open
uniqueg opened this issue Feb 4, 2024 · 2 comments · May be fixed by #177
Open

docs: describe ZARP outputs and how to use/explore them #165

uniqueg opened this issue Feb 4, 2024 · 2 comments · May be fixed by #177
Assignees
Labels
documentation Improvements or additions to documentation future will not be fixed for NOW

Comments

@uniqueg
Copy link
Member

uniqueg commented Feb 4, 2024

Is your feature request related to a problem? Please describe.

Currently, there is no documentation that describes the invidiual outputs that ZARP generates and how users can explore them and use them in downstream analyses.

Describe the solution you'd like

Add a section to the README.md that describes the workflow outputs.

Describe alternatives you've considered

N/A

Additional context

N/A

@uniqueg uniqueg added documentation Improvements or additions to documentation future will not be fixed for NOW labels Feb 4, 2024
@mkatsanto mkatsanto assigned mkatsanto and unassigned mkatsanto Feb 5, 2024
@fgypas fgypas self-assigned this Sep 3, 2024
@mkatsanto
Copy link
Collaborator

mkatsanto commented Oct 1, 2024

  • Add documentation on how to find and update tool resources (and profiles)
  • add the version update steps for containers in documention
  • explain rule_config and how to use it
  • provide a detailed table including minimum specifications, recommended configurations, and installation guidelines for different environments to improve user-friendliness
  • installation process
  • potential pitfalls, troubleshooting tips
  • Table listing the tools and their versions, specific tasks each tool performs, dependencies
  • more example codes, such as the installation of ZARP and each subsequent step of operation
  • How to add or modify profiles
  • Installation for mac users (only linux env for now)
  • customised containers
  • How to contribute

@mkatsanto mkatsanto self-assigned this Oct 1, 2024
@fgypas
Copy link
Member

fgypas commented Nov 25, 2024

  • Create your own version of a tool
  • Fix execution with docker section in Usage page

@fgypas fgypas linked a pull request Dec 10, 2024 that will close this issue
12 tasks
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 future will not be fixed for NOW
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants