CoronalLoopBuilder/setup.py at main · sageyu123/CoronalLoopBuilder · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

from setuptools import setup, find_packages

setup(
    name="CoronalLoopBuilder",
    version="0.1.0",
    description="A Python package to generate and visualize coronal loops on solar images.",
    long_description='''# CoronalLoopBuilder

CoronalLoopBuilder is a Python package designed to generate and visualize coronal loops on solar images viewed from different observers.

## Features

- **Interactive Visualization**: Use the `CoronalLoopBuilder` to interactively adjust parameters and customize the appearance of the coronal loops on solar images.

- **Support for Multiple Observers**: The tool can visualize loops from the perspective of multiple observers. For instance, if you provide a SDO/AIA map and a SoLO/STIX map, the code will visualize the loop from both viewing perspectives.

- **Dummy Maps for Demonstration**: The package comes with dummy solar images to demonstrate its functionality. However, these can be replaced with any real solar images observed from different instruments.

## Usage

1. **Installation**: Clone the repository and navigate to its directory. Then, install the required dependencies using:
    ```bash
    git clone https://github.com/sageyu123/CoronalLoopBuilder.git
    cd CoronalLoopBuilder
    pip install -r requirements.txt
    ```

2. **Running the Example**: Navigate to the `examples` directory and run the provided [example script](./examples/fig-singleloop.py) to see the `CoronalLoopBuilder` in action.

3. **Integration with Solar Images**: Replace the dummy maps in the example with real solar images to visualize coronal loops on actual solar observations.
   ![example](./examples/fig-singleloop.png)
   ![example](./examples/fig-settings.png)

## Contributing

We welcome contributions from the community! Here's how you can contribute:

1. **Fork the Repository**: Click on the 'Fork' button at the top right corner of the repository page to create a copy of the repository in your GitHub account.

2. **Clone Your Fork**: Clone the forked repository to your local machine.

3. **Make Changes**: Implement your changes, enhancements, or bug fixes.

4. **Commit and Push**: Commit your changes and push them to your forked repository on GitHub.

5. **Create a Pull Request**: Navigate to the 'Pull Requests' tab of the original repository and click on 'New Pull Request'. Choose your fork and the branch containing your changes, then create the pull request.

Please ensure that your code adheres to our coding standards and includes appropriate tests and documentation.

## License

This project is licensed under the MIT License. See the `LICENSE` file for details.
''',
    long_description_content_type="text/markdown",
    author="Unknown",  # Placeholder, should be replaced with actual author name if available
    license="MIT",    # Assuming MIT based on commonly used licenses; should be updated if different
    url="https://github.com/sageyu123/CoronalLoopBuilder",
    packages=find_packages(),
    install_requires=['numpy>=1.25.0\n', 'sunpy>=4.0.0\n', 'astropy>=5.0\n', 'scipy>=1.10.0\n', 'matplotlib>=3.7.0\n'],
    classifiers=[
        "Development Status :: 3 - Alpha",
        "Intended Audience :: Science/Research",
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
    ],
)