Skip to content

Commit

Permalink
Included some more info in README
Browse files Browse the repository at this point in the history
  • Loading branch information
facusapienza21 committed Jan 12, 2024
1 parent ac1098c commit f0c9a67
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,25 @@
[![codecov](https://codecov.io/gh/facusapienza21/SphereUDE.jl/graph/badge.svg?token=UC0KFSUU3X)](https://codecov.io/gh/facusapienza21/SphereUDE.jl)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

SphereUDE.jl is a Julia package for non-parametric regression of data supported in the three-dimensional sphere.
It implements a simple universal differential equation (UDE) that naturaly constrains path to lie in the sphere.
This has important application in Paleomagnetism, where the objective is to fit Aparent Polar Wander Paths (APWPs) to recunstruct continents past motion.
In addition to sphere regression, SphereUDE.jl implements a series of improvements over previous modelling methods, such as
- Explicit sphere constrint that allows for univesality of regression
- Regularization on the path to incorporate physical priors
- Incorporation of temporal and spatial uncertanties
- Uncertanty quantification capabilities

## Installing SphereUDE

## Python setup
In order to install `SphereUDE` in a given environment, just do in the REPL:
```julia
julia> ] # enter Pkg mode
(@v1.9) pkg> activate MyEnvironment # or activate whatever path for the Julia environment
(MyEnvironment) pkg> add SphereUDE
```

## SphereUDE initialization: integration with Python

In order to make plots using Matplotlib, Cartopy, and PMagPy, we install both [PyCall.jl](https://github.com/JuliaPy/PyCall.jl) and [PyPlot.jl](https://github.com/JuliaPy/PyPlot.jl) and execute Python code directly from Julia. In order to do this setup manually, you can follow the next steps.

Expand Down

2 comments on commit f0c9a67

@facusapienza21
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/98741

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" f0c9a674b413c9ae3228220c2c3a44d755c3bbb1
git push origin v0.1.0

Please sign in to comment.