FAQ / Troubleshooting
======================


## I get an error when doing `from caldip import readers`

This is because your code can't find the project `caldip`.

**Option 1:** Install the package `caldip` locally

Activate your environment.

```
micromamba activate template_env
```

then install your project from the terminal window in, e.g., `/Users/eddifying/github/caldip` as
```
pip install -e .
```
This will set it up so that you are installing the package in "editable" mode.  Then any changes you make to the scripts will be taken into account (though you may need to restart your kernel).

**Option 2:** Add the path to `caldip` to the code

Alternatively, you could add to your notebook some lines so that your code can "find" the package.  This might look like
```
import sys
sys.path.append('/Users/eddifying/github/caldip')
```
before the line where you try `from caldip import readers`.

## Failing to install the package in a Github Action

```
× Getting requirements to build editable did not run successfully.
│ exit code: 1
╰─> See above for output.
```

To test the installation, you'll want a fresh environment.

**In a terminal window, at the root of your project** (for me, this is `/Users/eddifying/github/caldip/`), run the following commands in order.
```
virtualenv venv
source venv/bin/activate && micromamba deactivate
pip install -e ".[dev]"
```

Then check and troubleshoot any errors.  When this runs, you are probably ready to try it with the GitHub Actions (where the workflows are in your repository in `.github/workflows/*.yml`)

## What's the difference between the repository name and the python package name??

Here, they are both called caldip, but the outer folder caldip/ is the repository, while the inner folder `caldip/caldip/` contains the package modules (e.g. readers.py).

Our repository is called `caldip`.  You can have dashes in a repository name.

Within the repository, the code (`*.py` files) are located in a subdirectory called `caldip`.  This is the package or module that we are creating and that will be installed, e.g., by `pip` when you do a `pip install -e .`.  Python packages should not have dashes in them!