Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.87 KB

install.md

File metadata and controls

52 lines (37 loc) · 1.87 KB
Raw

Installation

For Development

  1. Fork the repo into your personal github account

  2. At this point, you can start a Github Codespace if you like. If you do this, ignore the local installation instrutions below.

  3. On your local computer, install poetry and consider setting the configuration such that virtual environments for a given projects are installed in that project directory.

  4. I suggest that you do this so that poetry builds the virtual environment in your project directory:

poetry config virtualenvs.in-project true
  1. Next, I like working on a fork rather than the actual repository of record. I set my git remotes so that origin points to my fork, and upstream points to the 'upstream' repository.
➜  isocomp git:(develop) ✗ git remote -v 
origin  https://github.com/cmatKhan/isocomp.git (fetch)
origin  https://github.com/cmatKhan/isocomp.git (push)
upstream        https://github.com/collaborativebioinformatics/isocomp.git (fetch)
upstream        https://github.com/collaborativebioinformatics/isocomp.git (push)
  1. On your machine, cd into your local repository, git checkout the development branch, and make sure it is up-to-date with the upstream (ie the original) repository.

NOTE: if you branch, in general make sure you branch off the develop repo, not main!

  1. Create a virtual environment in the current directory like so:
poetry install

This will install the virtual environment with the dependencies (and the dependencies' dependencies) listed in the pyproject.toml.

  1. If you wish to simultaneously develop both code and docs, then you can start the documentation development server:
mkdocs serve