Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Actions with Lychee and GitHub Token #6

Merged
merged 5 commits into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ jobs:
- name: Run Ultralytics Formatting
uses: ultralytics/actions@main
with:
token: ${{ secrets.GITHUB_TOKEN }} # automatically generated
python: true
docstrings: true
markdown: true
spelling: true
links: true
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

Welcome to the Neutron TimeCube (NTC) analysis tools repository! This project is designed to provide researchers and data analysts with tools to interpret and visualize data from the NTC, a sophisticated device used in neutron detection and characterization.

[![Ultralytics Actions](https://github.com/ultralytics/ntc/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/ntc/actions/workflows/format.yml)

## πŸ“œ Description

The repository available at [ultralytics/ntc](https://github.com/ultralytics/ntc) houses a suite of MATLAB scripts and functions tailored for the analysis of neutron detection data. With these tools, users can process, analyze, and visualize NTC data, facilitating cutting-edge research in neutron science.
Expand All @@ -15,16 +17,16 @@ Before diving in, make sure you have the following prerequisites:

- [MATLAB](https://www.mathworks.com/products/matlab.html) version 2018a or higher.
- Access to the 'functions-matlab' common functions repository:
```bash
$ git clone https://github.com/ultralytics/functions-matlab
```
Add the repository to the MATLAB path using:
```matlab
>> addpath(genpath('/path/to/functions-matlab'))
```
```bash
$ git clone https://github.com/ultralytics/functions-matlab
```
Add the repository to the MATLAB path using:
```matlab
>> addpath(genpath('/path/to/functions-matlab'))
```
- The following MATLAB toolboxes should be installed:
- Statistics and Machine Learning Toolbox
- Signal Processing Toolbox
- Statistics and Machine Learning Toolbox
- Signal Processing Toolbox

Ensure that all installations and configurations match these requirements to smoothly run the NTC analysis tools.

Expand All @@ -34,13 +36,13 @@ To begin analyzing your data:

1. Open MATLAB
2. Execute the command:
```matlab
>> NTCviewer
```
```matlab
>> NTCviewer
```

Here is a glimpse of the kind of interface you can expect with our `NTCviewer`:

![mtcView Interface](https://github.com/University-of-Hawaii-Physics/mtc/blob/master/Analysis/Ultralytics/mtcview.png "mtcView")
![mtcView Interface](https://github.com/ultralytics/ntc/assets/26833433/32d0b7b9-4626-43c8-9ae1-85930414ea70)

## 🀝 Contribute

Expand Down