mihirkatare / DeepMEM

Deep Learning Implementations for Sustainable Matrix Element Method Calculations [ IRIS-HEP Fellowship ]
Apache License 2.0
2 stars 0 forks source link

Add environment requirements files #2

Closed matthewfeickert closed 3 years ago

matthewfeickert commented 3 years ago

Now that you have some code in the repo it is a good idea to create Python virtual environment files that make the necessary dependencies for those environments reproducible. So this would be something like a requirements.txt file that you can use with pip or an environment.yml file that you can use with Conda (If you're using Conda ideally you'd have both so that if someone wants to get your environment without using Conda they can).

So from

https://github.com/mihirkatare/DeepMEM/blob/9b33d4e179d062d37edce1007272e5ff413999bf/debug/debugdata.py#L1-L4

we can see that this (at minimum) would require something like a requirements.txt file containing

pandas~=1.2
torchvision~=0.9.1

as pandas will pickup the required version of numpy and torchvision will get torch

$ pip show pandas
Name: pandas
Version: 1.2.4
Summary: Powerful data structures for data analysis, time series, and statistics
Home-page: https://pandas.pydata.org
Author: None
Author-email: None
License: BSD
Location: /home/feickert/.pyenv/versions/3.8.7/envs/throw-away/lib/python3.8/site-packages
Requires: numpy, python-dateutil, pytz
Required-by: 
$ pip show torchvision
Name: torchvision
Version: 0.9.1
Summary: image and video datasets and models for torch deep learning
Home-page: https://github.com/pytorch/vision
Author: PyTorch Core Team
Author-email: soumith@pytorch.org
License: BSD
Location: /home/feickert/.pyenv/versions/3.8.7/envs/throw-away/lib/python3.8/site-packages
Requires: pillow, numpy, torch
Required-by: