Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overall cleanup and fixes #33

Merged
merged 2 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
The HORIZONS.jl package is licensed under the MIT "Expat" License:

> Copyright (c) 2017: Jorge Perez.
>
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
>
> The above copyright notice and this permission notice shall be included in all
> copies or substantial portions of the Software.
>
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.
>
>
3 changes: 2 additions & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name = "HORIZONS"
uuid = "5a3ac768-beb4-554a-9c98-3342fe3377f5"
repo = "https://github.com/PerezHz/HORIZONS.jl.git"
version = "0.4.0"
authors = ["Jorge A. Pérez Hernández", "Luis Eduardo Ramírez Montoya"]
version = "0.4.1"

[deps]
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
Expand Down
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,27 @@

[![codecov](https://codecov.io/gh/PerezHz/HORIZONS.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/PerezHz/HORIZONS.jl) [![Coverage Status](https://coveralls.io/repos/github/PerezHz/HORIZONS.jl/badge.svg?branch=master)](https://coveralls.io/github/PerezHz/HORIZONS.jl?branch=master)

An interface to JPL Solar System Dynamics [APIs](https://ssd.jpl.nasa.gov/api.html) in
An interface to JPL [HORIZONS](https://ssd.jpl.nasa.gov/horizons) system and other Solar System Dynamics [APIs](https://ssd.jpl.nasa.gov/api.html) in
[Julia](http://julialang.org).

## Author
## Authors

- [Jorge A. Pérez-Hernández](https://www.linkedin.com/in/perezhz),
Instituto de Ciencias Físicas, Universidad Nacional Autónoma de México (UNAM)
- [Luis Eduardo Ramírez Montoya](https://github.com/LuEdRaMo),
Facultad de Ciencias, Universidad Nacional Autónoma de México (UNAM)

Comments, suggestions, and improvements are welcome and appreciated.

## Installation

`HORIZONS.jl` is a registered Julia package and may be installed
from the Julia REPL doing
from the Julia REPL doing
```
] add HORIZONS
```
Current stable
release is `v0.4.0`, which is compatible with Julia >= 1.6.
release is `v0.4.1`, which is compatible with Julia >= 1.6.

## Usage examples

Expand All @@ -42,7 +44,8 @@ System news updated June 08, 2020

Horizons>
```
To run this function, the `telnet` command line utility should be locally installed and enabled.
To run this function, the `telnet` command line utility should be locally installed and
enabled.



Expand Down Expand Up @@ -143,7 +146,8 @@ apophisvt = vec_tbl("Apophis", t_start, t_stop, δt)

### Small-Body DataBase API

`HORIZONS.jl` function `sbdb` fetchs data for a specific small-body in JPL's Small-Body DataBase (SBDB) and returns the output as a `Dict{String, Any}`:
`HORIZONS.jl` function `sbdb` fetchs data for a specific small-body in JPL's Small-Body
DataBase (SBDB) and returns the output as a `Dict{String, Any}`:

```julia
# Fetch data of asteroid 433 Eros
Expand All @@ -155,12 +159,13 @@ sbdb("sstr" => "Apophis", "ca-data" => "true")

### Small-Body Radar Astrometry API

`HORIZONS.jl` function `sbradar` searches for radar astrometry of asteroids/commets and returns the output as a `Dict{String, Any}`:
`HORIZONS.jl` function `sbradar` searches for radar astrometry of asteroids/commets and
returns the output as a `Dict{String, Any}`:

```julia
# Search Apophis' radar astrometry
sbradar("spk" => "20099942")

# Add observer information
sbradar("spk" => "20099942", "observer" => "true")
```
Expand All @@ -169,9 +174,21 @@ sbradar("spk" => "20099942", "observer" => "true")

`HORIZONS.jl` is licensed under the [MIT "Expat" license](./LICENSE.md).

## Disclaimer

This software package is not affiliated, associated, authorized, endorsed by, or in any way
officially connected with NASA, JPL, or any of its subsidiaries or its affiliates.

## Acknowledgments

The [HORIZONS](https://ssd.jpl.nasa.gov/?horizons) system itself is the work of several people at JPL:
JAPH is thankful to Dr. Jon Giorgini for his helpful comments and feedback towards
the first release of this Julia interface to the HORIZONS system. Thanks to Yuri
D'Elia for their help with the telnet interface via
[Expect.jl](https://gitlab.com/wavexx/Expect.jl). Special thanks to Luis Eduardo
Ramírez Montoya ([@LuEdRaMo](https://github.com/LuEdRaMo)) for the implementation of the
JPL APIs via HTTP. The
[HORIZONS](https://ssd.jpl.nasa.gov/?horizons) system itself is the work of several people
at JPL:

* Design/implementation :
- Jon Giorgini
Expand Down
46 changes: 0 additions & 46 deletions appveyor.yml

This file was deleted.

89 changes: 0 additions & 89 deletions src/SCRIPTS/README

This file was deleted.

Loading
Loading