Metadata-Version: 2.4
Name: direcd
Version: 1.0.0
Summary: DIRECD python package
Author-email: Shantanu Jain <s.jain@rcdei.com>
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy==1.26.0
Requires-Dist: aiapy==0.8.0
Requires-Dist: mplcursors>=0.5
Requires-Dist: sphinx-rtd-theme
Requires-Dist: astropy>=5.0
Requires-Dist: click>=8.0
Requires-Dist: astroquery==0.4.7
Requires-Dist: matplotlib==3.10.1
Requires-Dist: matplotlib-inline==0.1.7
Requires-Dist: moviepy==1.0.3
Requires-Dist: pandas==2.2.2
Requires-Dist: pillow==10.4.0
Requires-Dist: plotly==6.0.1
Requires-Dist: scikit-image==0.24.0
Requires-Dist: scikit-learn==1.6.1
Requires-Dist: scipy==1.14.1
Requires-Dist: seaborn==0.13.2
Requires-Dist: statsmodels==0.14.4
Requires-Dist: streamlit==1.43.1
Requires-Dist: sunpy==5.0.0
Requires-Dist: sympy==1.13.2
Requires-Dist: hvpy==1.1.0
Requires-Dist: glymur==0.13.6
Dynamic: license-file

# DIRECD (Dimming Inferred Estimation of CME Direction)
=================

DIRECD (Dimming Inferred Estimation of CME Direction) is a novel method to characterize the early CME propagation direction from the expansion of coronal dimmings. 

For more details refer to our article: [Shantanu Jain et al. (2022). Coronal dimmings as indicators of the direction of early coronal mass ejection propagation. A&A 683 A15 (2024)](https://doi.org/10.1051/0004-6361/202347927)

The DIRECD-soft GUI is developed to provide the necessary tools to perform early CME direction analysis using 
coronal dimmings. This package has been built in Python (3.10) with an extensive use of libraries available within
the Python language ecosystem. The GUI of this application has been built based on Streamlit, an open-source Python 
library that provides an easy way to create web applications and tested on windows-based operating system.

Link to article:

## License
---------------------
This function is released under the Apache License. You can find the license file in the root directory of the GitHub repository.


## Acknowledging or Citing
-----------------------

If you use DIRECD for scientific work or research presented in a publication, please cite it by acknowledging in the main text its use and include the following citation:

[Shantanu Jain et al. (2022). Coronal dimmings as indicators of the direction of early coronal mass ejection propagation. A&A 683 A15 (2024)](https://doi.org/10.1051/0004-6361/202347927)

**Application of DIRECD**: [Shantanu Jain et al. Estimating the early propagation direction of the coronal mass ejection with DIRECD during the severe event on May 8 and for the follow-up event on June 8, 2024. A&A 692 A214 (2024)](https://doi.org/10.1051/0004-6361/202452324), 
[Tatiana Podladchikova et al. Three-part structure of a solar coronal mass ejection observed in low coronal signatures of Solar Orbiter. A&A 691 A344 (2024)](https://doi.org/10.1051/0004-6361/202451777)

**Statistical Application of DIRECD**: [Shantanu Jain et al. Validating DIRECD: Statistical Analysis of
Coronal Mass Ejections Direction Estimates from Coronal Dimmings, ApJS 281 14 (2025)](https://doi.org/10.3847/1538-4365/ae0a27)

## Contact
-----------------------

 Please report any bugs or issues you find by opening an issue on our GitHub repository or contacting our team at direcd.soft@gmail.com. Be sure to include a description of the problem and any error messages you received.

 ## Contributors of the repository
 ---------------------
* Shantanu Jain
* Tatiana Podladchikova



