search

BenDB3199 / Attitude_from_quaternions

The code takes in quaternions and a timestamp along with TLE data from the OPS-SAT and outputs satellite attitude information like roll, pitch, yaw and angle to nadir.
0 stars 0 forks source link

Use virtual environment to install and run your code #6

Closed georgeslabreche closed 3 years ago

georgeslabreche commented 3 years ago

Here's some reading material on the subject:

Be sure to document the installation process in the README. E.g. from one of my repos: image

BenDB3199 commented 3 years ago

Created the virtual environment. Doc in README.md:

Installation of the virtual enviornment

  1. Install the virtual environment: pip3 install --user virtualenv
  2. Create the virtal environment: python3 -m venv venv
  3. Start the virtual environment: source env/bin/activate
  4. Install package dependencies:
    pip3 install ephem pip3 install datetime pip3 install pyquaternion pip3 install numpy
  5. Create requirements.txt file: pip freeze > requirements.txt
georgeslabreche commented 3 years ago

You should provide the requirements.txt as a snapshot of a tested amnd working version of your project rather than having others generate their own based on the lastest version of the dependencies whenever they build your project for the first time. Why? Imagine you developed, tested, and deployed your project with version 1.5 of dependency D. Then a year later a bunch of people want to use your code and since you last worked on it dependency D has evolved from v1.5 and v2.0. It turns out that v2.0 is not backward compatible. What's gonna happen?

georgeslabreche commented 3 years ago

@BenDB3199 I just want to make sure you understand why I had re-opened this issue. @TanguySoto thank you for fixing!