Welcome to the cloud file system utilities!

cloud-fs is a generalized file-system handler that will dynamically determine if files are local or on the cloud (currently AWS) and perform basic file-systm operations.

Installing cloud_fs

Option 1: Install from PIP or Conda (recommended for analysts):

1. Create a new environment:

   conda create --name cloud_fs python=3.7

2. Activate directory:

   conda activate cloud_fs

3. Install cloud_fs:

   1. pip install NREL-cloud_fs or
   2. conda install nrel-cloud_fs --channel=nrel

Option 2: Clone repo (recommended for developers)

1. from home dir, git clone git@github.com:NREL/cloud_fs.git

2. Create cloud_fs environment and install package

   1. Create a conda env: conda create -n cloud_fs
   2. Run the command: conda activate cloud_fs
   3. cd into the repo cloned in 1.
   4. prior to running pip below, make sure the branch is correct (install from main!)
   5. Install cloud_fs and its dependencies by running: pip install . (or pip install -e . if running a dev branch or working on the source code)