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

Integrate dynophore generation and visualization #51

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

dominiquesydow
Copy link
Collaborator

@dominiquesydow dominiquesydow commented Nov 9, 2021

Description

Enable combined dynophore generation and visualization from CLI.

Todos

Notable points that this PR has either accomplished or will accomplish.

  • Restructure CLI entirely (rename CLI command from dynoviz to dynophore
    • dynophore create: Generate and visualize dynophore data (visualization in Jupyter notebook)
    • dynophore visualize: Visualize already generated dynophore data (set up notebook)
    • dynophore demo: Show demo visualization (set up example notebook)
  • Add heavy lifting to dynophores.api module; call functions from there in dynophores.cli
  • Do not open notebook automatically; instead, print at the very end the command to the console that the user needs to type to load the notebook
  • Update CLI instructions in documentation
  • Update CLI-related tests (use test code from teachopencadd)
  • Enable file downloads from any OS (at the moment we are using wget (only pip installable, and I think only for Linux; check!) > use standard library urllib

Questions

  • Dynophore output paths have time-stamps; that complicates the generation>visualization; can we maybe loose the time tag? > keep this for now; I am searching for the latest file
  • At the moment the console output is quite a zoo due to the two packages that are run; clean that up!

Status

  • Ready to go

@dominiquesydow dominiquesydow added the enhancement New feature or request label Nov 9, 2021
@dominiquesydow dominiquesydow self-assigned this Nov 9, 2021
@dominiquesydow dominiquesydow mentioned this pull request Nov 10, 2021
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant