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

Restructure repo for usability #37

Closed
milroy opened this issue Apr 2, 2023 · 2 comments
Closed

Restructure repo for usability #37

milroy opened this issue Apr 2, 2023 · 2 comments

Comments

@milroy
Copy link
Member

milroy commented Apr 2, 2023

The current main branch contains out of date instructions and examples. We need to update it to make it usable. Items to consider:

  • replace the contents of the examples directory with examples from the CANOPIE22 paper
  • update the README to include build and running instructions from the CANOPIE22 paper

Other suggestions are welcome.

@vsoch
Copy link
Member

vsoch commented Apr 2, 2023

Whatever you and @cmisale decide, I can give it a test run and give feedback if anything is unclear since I haven’t used anything here.

I’m not sure about the content of the paper, but if there is a container build or similar it might make sense to automate that or at least make sure there is one available alongside the repository.

TLDR let me know how I can help.

@vsoch
Copy link
Member

vsoch commented Jan 5, 2024

I think we are good to close here - we have good documentation in the README for deployment (from our containers) and custom builds, along with instructions for a pod example, and TBA job example (used for testing) that will come with #49

@vsoch vsoch closed this as completed Jan 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants