nitred / nr-wg-mtu-finder

MIT License
202 stars 22 forks source link

Python environment creation and `nr-wg-mtu-finder` installation instructions #14

Open nitred opened 1 year ago

nitred commented 1 year ago

I'd like this issue to be the reference for Python environment creation and package installation instructions. When all the kinks have been ironed out, I will move these instructions into the Readme.

It's hard to find a single set of instructions that will work for everyone. Please leave your notes and instructions for your own environment manager preferefences (e.g. conda, venv, poetry, brew etc) in the comments below.

nitred commented 1 year ago

Here are the instructions to install nr-wg-mtu-finder for:

Instructions

  1. Make sure you have the conda executable in your path. If you don't, you can learn how to download and install Miniconda here.
  2. After step 1, you should run the command which conda in your terminal and you should see an output similar to the following:
    >>> /home/USER/anaconda3/bin/conda
    or
    >>> /home/USER/miniconda3/bin/conda
  3. Create an Python 3.9 environment just for nr-wg-mtu-finder by running the following command. We will call the environment nr-wg-mtu-finder as well.
    conda create -n nr-wg-mtu-finder python=3.9 -y
  4. Activate the new environment that you just created.
    conda activate nr-wg-mtu-finder
  5. Make sure that your environment is correctly activated. Run the following command in your terminal and you should see an output similar to the following:
    >>> /home/USER/anaconda3/envs/nr-wg-mtu-finder/bin/python
    or 
    >>> /home/USER/miniconda3/envs/nr-wg-mtu-finder/bin/python
  6. Install the latest version of nr-wg-mtu-finder within this environment by running the following command
    pip install nr-wg-mtu-finder --upgrade
  7. Finally, verify that nr-wg-mtu-finder has been installed in your environment by running which nr-wg-mtu-finder in your terminal and you should see an output similar to the following:
    >>> /home/USER/anaconda3/envs/nr-wg-mtu-finder/bin/nr-wg-mtu-finder
    or
    >>> /home/USER/miniconda3/envs/nr-wg-mtu-finder/bin/nr-wg-mtu-finder
  8. You've successfully installed nr-wg-mtu-finder and you can continue with the usage instructions in the README. Remember that you will need to do this installation twice, once on the WG-Server and once on the WG-Peer.