To make it easy for you to get started with GitLab, here's a list of recommended next steps.
### 1. Install Conda
If you don't already have Conda installed, download it from [conda.io](https://docs.conda.io/en/latest/miniconda.html).
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
### 2. Install gfortran
## Add your files
**macOS:**
```bash
brew install gcc
```
**Linux:**
```bash
sudo apt install gfortran
```
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
### 3. Install Git
-[ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://www.ict.inaf.it/gitlab/guibrushr/datareductiongianob/-/settings/integrations)
## Installation
## Collaborate with your team
> **Important:** To access the DataReductionGIANOB project, please email [paolo.giacobbe@inaf.it](mailto:paolo.giacobbe@inaf.it) or [francesco.amadori@inaf.it](mailto:francesco.amadori@inaf.it) to request an invitation to the GitLab group.
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
### Step 1: Clone the Repository
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
### Step 2: Create Conda Environment
```bash
conda create -n guibrushr_env python=3.10
```
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
### Step 3: Activate the Environment
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
```bash
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
conda activate guibrushr_env
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
```
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
### Step 4: Install DataReductionGIANOB
# Editing this README
Navigate to the DataReductionGIANOB folder and install in development mode:
```bash
cd /preferred/path/guibrushr/DataReductionGIANOB
pip install-e .
```
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
---
## Suggestions for a good README
## Configuration File Setup
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
### Setting up petitRADTRANS
## Name
DataReductionGIANOB requires **gofio** to be properly configured. Follow the official tutorial to set up the `gofio` folder:
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
### Pre-flight Checklist
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Before running GUIBRUSHR, ensure you have completed the following:
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
- ✅ Defined the location of your `gofio` folder
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
- ✅ Defined the location of your `target` folder
> **Note:** These configurations are essential for DataReductionGIANOB to correctly start.
### Creating the Configuration File
#### Step 1: Navigate to Configuration Directory
```bash
cd /preferred/path/guibrushr/DataReductionGIANOB/DataReductionGIANOB/Files/Configuration_Path/
```
#### Step 2: Create `configuration.csv`
Create a file named `configuration.csv` with the following structure:
```csv
Element,Path
path_target,/target/preferred/path/
path_gofio,/gofio/preferred/path
```
#### Configuration Example
Here's a complete example of the `configuration.csv` file:
| `path_target` | Absolute path to your DataReductionGIANOB target data folder |
| `path_gofio` | Absolute path to your `gofio` folder |
> **Tip:** Use absolute paths to avoid potential path resolution issues.
---
## Usage
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
### Activate the Environment
Before using DataReductionGIANOB, always activate the Conda environment:
```bash
conda activate guibrushr_env
```
### Launch DataReductionGIANOB
Navigate to the DataReductionGIANOB directory and start the application:
```bash
cd /preferred/path/guibrushr/DataReductionGIANOB
python Start_Data_Reduction.py
```
---
## Support
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
For questions, bug reports, or technical assistance, please contact:
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
## Troubleshooting
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
### Common Issues
## Authors and acknowledgment
**Environment activation error:**
Show your appreciation to those who have contributed to the project.
```bash
# Make sure you created the environment with the correct name
conda env list
```
**Import errors after installation:**
```bash
# Reinstall in development mode
pip install-e.--force-reinstall
```
**Configuration file not found:**
- Verify the `configuration.csv` file exists in the correct directory
- Check that paths in the CSV file are absolute and correct
---
## License
## License
For open source projects, say how it is licensed.
## Project status
DataReductionGIANOB is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
