Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 979 Bytes

README.md

File metadata and controls

23 lines (16 loc) · 979 Bytes

Research_Tools

Package for generic functions and equations compiled from various sources during my PhD career.

Description

This is a non-production package which is used by my other packages.

Installation

Currently, the only proven install method for this repo is to download the repository to your code folder and pip install via:

pip install -e "path\to\your\python\project"

If using conda, be sure install in a separate environment to protect your installation.

Alternate

Code should also be available for use if "toolbox" folder is placed into your own directory

Contents

  • utils: Contains project management scripts unrelated to the library
    • init_util.py: Create str for __init__.py files or push updates to all packages
    • gen_package_list.py: create an env.yml
  • equations: Contains scripts w/ basic equations which can be called an manipulated
  • functions: Contains useful operational functions to interface with data or os