Skip to content

Commit

Permalink
Improve README (#2)
Browse files Browse the repository at this point in the history
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
  • Loading branch information
pderrenger and glenn-jocher authored Dec 5, 2023
1 parent 9ae3462 commit b881c1e
Showing 1 changed file with 62 additions and 17 deletions.
79 changes: 62 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,74 @@
<img src="https://storage.googleapis.com/ultralytics/UltralyticsLogoName1000×676.png" width="200">
<br><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320">

# Introduction
# 📜 Introduction

This directory contains software developed by Ultralytics LLC. For more information on Ultralytics projects please visit:
http://www.ultralytics.com  
Welcome to the Ultralytics open-source Earth observation repository! This space is dedicated to showcasing software designed by Ultralytics, illustrating the power of Machine Learning (ML) in geospatial analysis and observation. To discover a range of our innovative projects, head over to our website: [Ultralytics Projects](http://www.ultralytics.com).

# Description
# 🌍 Project Description

The https://github.com/ultralytics/magellan repo contains Earth observation software powered by Machine Learning (ML). Viewable in Google Maps and WebGL Earth:
The [Ultralytics Magellan Project](https://github.com/ultralytics/magellan) is at the forefront of integrating ML with Earth observation. It allows for ML-powered insights derived from geospatial data to be viewed and interacted with on platforms such as Google Maps and WebGL Earth, bringing a new dimension to data visualization and analysis.

- Google Mapshttps://storage.googleapis.com/neutronmap/neutronmap1/tileOverlayLarge.html
- WebGL Earthhttp://storage.googleapis.com/neutronmap/neutronmap1/webGLEarth.html
- Visualize on **Google Maps**: [Google Maps Visualization](https://storage.googleapis.com/neutronmap/neutronmap1/tileOverlayLarge.html)
- Explore on **WebGL Earth**: [WebGL Earth Interaction](http://storage.googleapis.com/neutronmap/neutronmap1/webGLEarth.html)

# Requirements
# 🛠 Requirements

[MATLAB](https://www.mathworks.com/products/matlab.html) >= 2018a with a common functions repo `$ git clone https://github.com/ultralytics/functions-matlab` added to the MATLAB path `>> addpath(genpath('/functions-matlab'))` and the following toolboxes:
To harness the capabilities of the Magellan project, the following are required:
- **MATLAB**: Version 2018a or newer. Please visit [MATLAB Software](https://www.mathworks.com/products/matlab.html) for installation details.
- **Supporting Utilities**: Clone the common functions repository by executing `$ git clone https://github.com/ultralytics/functions-matlab`. After cloning, incorporate it into your MATLAB environment with `>> addpath(genpath('/functions-matlab'))`.
- **MATLAB Toolboxes**: Ensure installation of the `Statistics and Machine Learning Toolbox` and the `Signal Processing Toolbox`.

- `Statistics and Machine Learning Toolbox`
- `Signal Processing Toolbox`
# 🚀 Getting Started

# Running
Various methods. Please contact for more information.
To utilize the Magellan software, various methods are available depending on your specific use case and expertise:

<img src="https://github.com/ultralytics/magellan/blob/master/neutron_map.png">
1. For a general overview of functionalities and navigation:
```matlab
% After setting up the MATLAB environment as per the requirements:
% Add your example code here with comments explaining each step
```

# Contact
2. For advanced configurations and custom runs:
- Please don't hesitate to reach out for more detailed instructions tailored to your needs.

For questions or comments please contact Glenn Jocher at glenn.jocher@ultralytics.com or visit us at http://www.ultralytics.com/contact
🖼️ Visualization Preview:

<img src="https://github.com/ultralytics/magellan/blob/master/neutron_map.png" alt="Magellan Neutron Map">

# 🤝 Contribute

We love your input! Ultralytics open-source efforts would not be possible without help from our community. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started, and fill out our [Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) to send us feedback on your experience. Thank you 🙏 to all our contributors!

<a href="https://github.com/ultralytics/magellan/graphs/contributors">
<img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png" alt="Ultralytics open-source contributors"></a>

# ©️ License

Ultralytics offers two licensing options to accommodate diverse use cases:

- **AGPL-3.0 License**: This [OSI-approved](https://opensource.org/licenses/) open-source license is ideal for students and enthusiasts, promoting open collaboration and knowledge sharing. See the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for more details.
- **Enterprise License**: Designed for commercial use, this license permits seamless integration of Ultralytics software and AI models into commercial goods and services, bypassing the open-source requirements of AGPL-3.0. If your scenario involves embedding our solutions into a commercial offering, reach out through [Ultralytics Licensing](https://ultralytics.com/license).

# 📬 Contact

For Ultralytics bug reports, feature requests, questions, or discussions, you are welcome to:

- Visit [GitHub Issues](https://github.com/ultralytics/magellan/issues) for official inquiries.
- Join our [Discord](https://ultralytics.com/discord) community for an interactive session with us and fellow community members.

<br>
<div align="center">
<a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.linkedin.com/company/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="Ultralytics LinkedIn"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://twitter.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="Ultralytics Twitter"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://youtube.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="3%" alt="Ultralytics YouTube"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.tiktok.com/@ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="3%" alt="Ultralytics TikTok"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.instagram.com/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="3%" alt="Ultralytics Instagram"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://ultralytics.com/discord"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png" width="3%" alt="Ultralytics Discord"></a>
</div>

0 comments on commit b881c1e

Please sign in to comment.