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.

Sign up for GitHub

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

Jump to bottom

Clean up repository #1

Open
viviaxenov opened this issue Oct 11, 2019 · 0 comments
Open

Clean up repository #1

viviaxenov opened this issue Oct 11, 2019 · 0 comments
Assignees
@viviaxenov
Labels
enhancement New feature or request

Comments

@viviaxenov
Copy link
Owner

viviaxenov commented Oct 11, 2019 •
edited
Loading

Encounter with Mihail has shown that repo is in a really bad state. Many test files are deprecated, there is no way for an external user to understand how to use the code. There possibly are some (hopefully minor) bugs. We have to:

  • Get those test scripts that are illustrative in shape and store them as example case studies (working code + some comments).
  • Get rid of the rest.
  • Provide autotests
  • Make a decent README.md
  • Optional: think of implementing some kind of API (some handy functions to easily access model from other code, e.g. Mihail's ML stuff)

I suggest we do it after the analytical verification and current conference busyness, but before or in parallel with implementation of destruction model.
@viviaxenov viviaxenov added the enhancement New feature or request label Oct 11, 2019
@viviaxenov viviaxenov self-assigned this Oct 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@viviaxenov viviaxenov

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@viviaxenov