|
11 | 11 |
|
12 | 12 | ## Getting Started |
13 | 13 | 1. Start by cloning this repository locally. |
14 | | -2. Next, within an conda terminal navigate to the local repository location and clone and activate our conda virtual environment using `environment.yml`. |
| 14 | +2. Next, within an conda terminal navigate to the local repository location and clone and activate our conda virtual environment using `environment_demo.yml`. |
| 15 | + * `environment_dev.yml` currently does not recognize the 'jupyter lab' command |
15 | 16 | ``` |
16 | 17 | # mock conda terminal |
17 | 18 | (base) C://User: cd Path/To/Xarray-DataAccessor |
18 | | -(base) C://User/Path/To/Xarray-DataAccessor conda env create -f environment.yml |
| 19 | +(base) C://User/Path/To/Xarray-DataAccessor conda env create -f environment_demo.yml |
19 | 20 | ... |
20 | | -(base) C://User/Path/To/Xarray-DataAccessor conda activate xarray_data_accessor_env |
21 | | -(xarray_data_accessor_env) C://User/Path/To/Xarray-DataAccessor |
| 21 | +(base) C://User/Path/To/Xarray-DataAccessor conda activate data_accessor_full |
| 22 | + (data_accessor_full) C://User/Path/To/Xarray-DataAccessor |
22 | 23 | ``` |
23 | 24 | 3. (optional) if you plan to use the `CDSDataAccessor`, follow the instructions [here](https://cds.climate.copernicus.eu/api-how-to) to allow your computer to interact with the CDS API. Basically you must manually make a `.cdsapirc` text file (no extension!) where `cdsapi.Client()` expects it to be. |
24 | | -4. Use the [conda-develop](https://docs.conda.io/projects/conda-build/en/latest/resources/commands/conda-develop.html) `build` command pointed to the `/src/` directory to make the repo importable. |
| 25 | +4. Use the [conda-develop](https://docs.conda.io/projects/conda-build/en/latest/resources/commands/conda-develop.html) `develop` command pointed to the `/src/` directory to make the repo importable. |
25 | 26 | ``` |
26 | 27 | # mock conda terminal with the env activated |
27 | | -(xarray_data_accessor_env) C://User/Path/To/Xarray-DataAccessor conda-build src |
| 28 | +(data_accessor_full) C://User/Path/To/Xarray-DataAccessor conda develop src |
28 | 29 |
|
29 | 30 | # a this point you are ready to open an IDE/Notebook of your choice to run your code! |
30 | 31 | # For example: |
31 | | -(xarray_data_accessor_env) C://User/Path/To/Xarray-DataAccessor jupyterlab |
| 32 | +(data_accessor_full) C://User/Path/To/Xarray-DataAccessor jupyter lab |
32 | 33 | ``` |
33 | 34 | 5. Finally, import the library into your workflow: |
34 | 35 | ```python |
|
0 commit comments