Skip to content

Commit

Permalink
update test
Browse files Browse the repository at this point in the history
  • Loading branch information
christinahedges committed Jan 7, 2025
1 parent 51556de commit a29608f
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 5 deletions.
16 changes: 16 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ installing via poetry
pip install --upgrade poetry
poetry install .


Usage
-----

Expand Down Expand Up @@ -159,6 +160,21 @@ TESS kernels can be obtained from MAST:
https://archive.stsci.edu/missions/tess/engineering/
https://archive.stsci.edu/missions/tess/models/

When you first load `lkspacecraft` into Python all the kernels will be downloaded for you. This will take approximately 5 minutes, depending on your internet connection. Once this has been done, the kernels will be cached. If there are new TESS kernels available `lkspacecraft` will retrieve them for you and update the cache.

The total file volume for the kernels is ~1GB. These cached files are stored using `astropy`'s cache. If you want to clear the cache you can do either of the following;

```python
from lkspacecraft.utils import clear_download_cache
clear_download_cache()
```

```python
from astropy.utils.data import clear_download_cache
clear_download_cache(pkgname='lkspacecraft')
```


Extending ``lkspacecraft``
~~~~~~~~~~~~~~~~~~~~~

Expand Down
51 changes: 50 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ pydata-sphinx-theme = "^0.16.1"
sphinx-autobuild = "^2024.10.3"
ghp-import = "^2.1.0"
lxml = "^5.3.0"
flake8 = "^7.1.1"

[build-system]
requires = ["poetry-core"]
Expand Down
8 changes: 4 additions & 4 deletions src/lkspacecraft/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ def get_file_paths():
total=len(file_names),
desc="Downloading SPICE Kernels",
)
file_paths.append(get_file_path(url + file_name))
progress_bar.n = idx
progress_bar.refresh()
log.debug(f"Downloaded {file_name}.")
file_paths.append(get_file_path(url + file_name))
progress_bar.n = idx
progress_bar.refresh()
log.debug(f"Downloaded {file_name}.")
return file_paths


Expand Down

0 comments on commit a29608f

Please sign in to comment.