-
Notifications
You must be signed in to change notification settings - Fork 0
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
Improve documentation #35
Comments
Could you give step-by-step instructions for "preparing the virtual environments for OpusCleaner and OpusPocus". Also what to do if you want to use conda instead? |
I use the following:
Get the requirements-opuscleaner.txt from the opuscleaner repository. Alternatively, you can try replacing |
I meant, should this be in the documentation. It's maybe worth spelling out. |
We can put it in README.txt in the installation section. Although, ideally, OpusCleaner and OpusTrainer (the pipy versions) should not have conflicting dependencies, thus requiring only a single virtual env for OpusPocus (which has OpusTrainer as its pipy dependency). |
Yes, it would be ideal if we could remove the conflicts. I think then we would need some automated check (CI pipeline) to ensure that conflicts were not re-introduced, assuming both projects will be actively developed. |
This is incomplete
You also need to run |
We need to have detailed documentation for running OpusPocus on both slurm and bash. The current documentation is good for setting up OpusPocus but there are few gaps when running the pipeline.
The text was updated successfully, but these errors were encountered: