Skip to content

Commit

Permalink
Update format.yml (#6)
Browse files Browse the repository at this point in the history
Co-authored-by: glenn-jocher <[email protected]>
  • Loading branch information
UltralyticsAssistant and glenn-jocher committed Jan 1, 2024
1 parent 5891a8e commit 55b880e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
15 changes: 9 additions & 6 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ultralytics 🚀, AGPL-3.0 license
# Ultralytics Format Workflow
# This workflow automatically formats code and documentation in pull requests and pushes to main branch
# Ultralytics 🚀 - AGPL-3.0 license
# Ultralytics Actions https://github.com/ultralytics/actions
# This workflow automatically formats code and documentation in PRs to official Ultralytics standards

name: Ultralytics Actions

Expand All @@ -14,7 +14,10 @@ jobs:
format:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Run Ultralytics Formatting Actions
- name: Run Ultralytics Formatting
uses: ultralytics/actions@main
with:
python: true
docstrings: true
markdown: true
spelling: true
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ Enjoy the journey into the fascinating world of earth modeling and neutrino dete

The NUDAR project is a comprehensive suite of MATLAB simulations aimed at facilitating the theoretical study of antineutrino interactions and detections. This software plays a crucial role in enhancing our understanding of antineutrino properties and their applications in probing the Earth's interior and nuclear detection.

Our work is inspired and informed by the seminal paper by G. Jocher et al., titled "Theoretical Antineutrino Detection, Direction and Ranging at Long Distances," published in Physics Reports (Volume 527, Issue 3, 2013). For a deep dive into the scientific and theoretical backgrounds that underpin these simulations, please refer to the publication at:
http://dx.doi.org/10.1016/j.physrep.2013.01.005.
Our work is inspired and informed by the seminal paper by G. Jocher et al., titled "Theoretical Antineutrino Detection, Direction and Ranging at Long Distances," published in Physics Reports (Volume 527, Issue 3, 2013). For a deep dive into the scientific and theoretical backgrounds that underpin these simulations, please refer to the publication at: http://dx.doi.org/10.1016/j.physrep.2013.01.005.

![NUDAR](https://github.com/ultralytics/agm2015/blob/master/AGM2015small.jpg "Earth Modeling and Neutrino Detection Simulation")


## 🧰 Requirements

To get started with the NUDAR simulations, ensure that you have MATLAB (version 2018a or later) set up on your machine. Additionally, the simulations depend on a repository of common functions which should be included in your MATLAB environment.
Expand All @@ -31,29 +29,31 @@ Please follow these steps to prepare your work environment:
```matlab
>> addpath(genpath('/functions-matlab'))
```

**Note:** You should also have the following toolboxes installed in your MATLAB environment:

- `Statistics and Machine Learning Toolbox`
- `Signal Processing Toolbox`
- `Mapping Toolbox`

Required licenses for these toolboxes should be acquired through official MATLAB channels.


## 🚀 Running the Simulation

To launch the Interactive Detector Neutrino Direction and Ranging (iDND) tool, simply navigate to the MATLAB command window and enter:

```matlab
>> iDND
```
This command will initiate the simulation interface, allowing you to explore various neutrino detection scenarios and earth model configurations.

This command will initiate the simulation interface, allowing you to explore various neutrino detection scenarios and earth model configurations.

## 🤝 Contribute

We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your input is invaluable. Take a look at our [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our [Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 and thank you to all of our contributors!

<!-- Ultralytics contributors -->

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

Expand Down

0 comments on commit 55b880e

Please sign in to comment.