From f243c120a49b52ce32e685e3c7308ffd010a6e6b Mon Sep 17 00:00:00 2001 From: Kazunori Akiyama Date: Fri, 8 Dec 2023 15:00:01 -0500 Subject: [PATCH] update readme --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6da2e20..fe861a3 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,26 @@ # ScatteringOptics - [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://EHTJulia.github.io/ScatteringOptics.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://EHTJulia.github.io/ScatteringOptics.jl/dev/) [![Build Status](https://github.com/EHTJulia/ScatteringOptics.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/EHTJulia/ScatteringOptics.jl/actions/workflows/CI.yml?query=branch%3Amain) -[![Coverage](https://codecov.io/gh/EHTJulia/ScatteringOptics.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/EHTJulia/ScatteringOptics.jl) +[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) + +`ScatteringOptics.jl` is an astronomy software package developed in the Julia programming language for interstellar scintillation observed at radio wavelengths. It implements physical models for the anisotropic scattering of radio waves, which arise from turbulence in the ionized interstellar medium. + +This toolkit is aiming to provide capabilities of simulating and modeling the temporal, spatial, and spectral effects of interstellar scintillation primarily in the strong scattering regime, with taking advantage of Julia's speed and composability. +The package is designed to work with sky models and interferometric data types from the advanced Bayesian radio interferometric modeling package [`Comrade.jl`](https://github.com/ptiede/Comrade.jl). -This Julia Package provides a framework to simulate Interstellar-Medium-generated stochastic scattering on EHT VLBI models. +The package provides essential functionalities for modeling, analyzing, and interpreting the images of the Galactic Center's supermassive black hole, Sagittarius A*, especially with the Event Horizon Telescope, and also the images of extremely high brightness temperature emissions in active galactic nuclei using space very long baseline interferometry. ## Installation -The package is installable by +The package is registered in the Julia standard repository, and installable through the standard ways by ```julia using Pkg -Pkg.add("StationaryRandomFields") +Pkg.add("ScatteringOptics") ``` +or +```julia +]add ScatteringOptics +``` + +## Documentation +The documentation is available [here](https://ehtjulia.github.io/ScatteringOptics.jl). \ No newline at end of file