RLMM is a reinforcement learning env for molecular modeling (currently only protein-ligand docking).
Setting up env
Make sure you are using conda, and that is your base python. You can check by
which should show the base python from conda so for me it shows /Users/austin/anaconda3/bin/python.
python devtools/scripts/create_conda_env.py -n=test -p=3.6 devtools/conda-envs/test_env.yaml conda activate test python devtools/scripts/create_pip_installs.py -i devtools/conda-envs/test_env.yaml
and you should be all set. There is no need to run setup.py when working on deveolp. Not sure if that even works.
There are two ways to contribute to this project. If you are added to the project as a collaborator, please follow the steps in "Using Branch" section. Otherwise, you will have to use forks. The most important rule here is that we only use pull request to contribute and we never push directy to the master or develop branch.
- Clone the repository:
git clone firstname.lastname@example.org:aclyde11/RLMM.git.
- Create your own local feature branch:
git checkout -b your-own-feature-branch develop
- Make your own feature branch visible by pushing it to the remote repo (DO NOT PUSH IT TO THE DEVELOP BRANCH):
git push --set-upstream origin your-own-feature-branch
- Develop your own feature branch in your local repository:
git commit, etc..
- After your own branch is completed, make sure to merge the latest change from the remote develop branch to your own local develop branch: 1)
git checkout develop2)
- Now that your local develop branch is up to date, you can update your own feature branch by: 1)
git checkout your-own-feature-branch2)
git pull origin develop.
- Update your own feature branch on the remote repository by:
git push origin your-own-feature-branch
- Make a pull request with base being develop and compare being your-own-feature-branch
- After the pull request is merged, your-own-feature-branch on the remote repository will be soon deleted, delete it on your local repository by:
git branch -d your-own-feature-branch
Project based on the Computational Molecular Science Python Cookiecutter version 1.2.