Skip to content
Snippets Groups Projects
Commit 1f984c64 authored by Achilles Kappis's avatar Achilles Kappis
Browse files

Update README.md to use the new urls resulting from the port to the University...

Update README.md to use the new urls resulting from the port to the University of Southampton GitLab instance
parent 5308106e
No related branches found
No related tags found
No related merge requests found
# IN-NOVA
This repository holds the open-access codebase used within the "Directional microphone arrays for remote microphone virtual sensing" sub-project, under the [IN-NOVA](https://in-nova-horizon.eu/) project . The codebase is divided into various sections, each relevant to a different topic/problem. The sections will be updated and more sections will be added on an as-needed basis, since the purpose of the project is not to create a software library to tackle the scientific problems.
The codebase under each section may or may not include code implementations in different languages but no plan exists to port each implementation in all available programming languages. More information about the codebase, the available implementations and topics/fields can be found in the [Documentation](https://gitlab.com/in-nova/in-nova/-/tree/main/Documentation/latex?ref_type=heads) of the project and its [Wiki](https://gitlab.com/in-nova/in-nova/-/wikis/home).
This repository holds the open-access codebase used within the "Directional microphone arrays for remote microphone virtual sensing" sub-project, under the [IN-NOVA](https://in-nova-horizon.eu/) project . The codebase is divided into various sections, each relevant to a different topic/problem. The sections will be updated and more sections will be added on an as-needed basis, since the purpose of the project is not to create a software library to tackle the problems investigated in the project. The codebase under each section may or may not include code implementations in different languages but no plan exists to port each implementation in many languages.
## Current structure
The current structure of the codebase is shown below. More information can be found in the [Wiki](https://gitlab.com/in-nova/in-nova/-/wikis/home) with separate pages for each category, and implementation.
The current structure of the codebase is shown below.
- [Templates](https://gitlab.com/in-nova/in-nova/-/tree/main/Templates?ref_type=heads)
- [Templates](https://git.soton.ac.uk/in-nova/virtual-sensing/-/tree/main/Templates?ref_type=heads)
- Function templates
- [Utilities](https://gitlab.com/in-nova/in-nova/-/tree/main/Utilities?ref_type=heads)
- [Utilities](https://git.soton.ac.uk/in-nova/virtual-sensing/-/tree/main/Utilities?ref_type=heads)
- Generic
- Geometries
- [Active Noise Control](https://gitlab.com/in-nova/in-nova/-/tree/main/Active%20Noise%20Control?ref_type=heads)
- [Active Noise Control](https://git.soton.ac.uk/in-nova/virtual-sensing/-/tree/main/Active%20Noise%20Control?ref_type=heads)
- Optimal tonal control
- Frequency domain
- [Virtual Sensing](https://gitlab.com/in-nova/in-nova/-/tree/main/Virtual%20Sensing?ref_type=heads)
- [Virtual Sensing](https://git.soton.ac.uk/in-nova/virtual-sensing/-/tree/main/Virtual%20Sensing?ref_type=heads)
- Remote Microphone Technique
- Frequency domain
- Time domain
- [Optimisation](https://gitlab.com/in-nova/in-nova/-/tree/main/Optimisation/Memetic%20Algorithm?ref_type=heads)
- [Optimisation](https://git.soton.ac.uk/in-nova/virtual-sensing/-/tree/main/Optimisation?ref_type=heads)
- Memetic Algorithm
- [Signal Processing](https://gitlab.com/in-nova/in-nova/-/tree/main/Signal%20Processing?ref_type=heads)
- [Signal Processing](https://git.soton.ac.uk/in-nova/virtual-sensing/-/tree/main/Signal%20Processing?ref_type=heads)
- Array Processing
- Frequency domain
- Time domain
- Generic
- Measurements
- [Sound fields](https://gitlab.com/in-nova/in-nova/-/tree/main/Sound%20Fields?ref_type=heads)
- [Sound fields](https://git.soton.ac.uk/in-nova/virtual-sensing/-/tree/main/Sound%20Fields?ref_type=heads)
- Generation
- Frequency domain
- Time domain
......@@ -42,7 +40,7 @@ Effort has been put towards minimising dependencies external to this repository.
## Support
If you find any bugs, other issues and/or inconsistencies you can [e-mail](mailto::axilleaz@protonmail.com) Achilles Kappis at *<axilleaz@protonmail.com>* or *<A.Kappis@soton.ac.uk>*. More contacts will be added if/when new contributors join the project.
If you find any bugs, other issues and/or inconsistencies you can e-mail Achilles Kappis at *[<A.Kappis@soton.ac.uk>*](mailto::A.Kappis@soton.ac.uk). More contacts will be added if/when new contributors join the project.
## Roadmap
......@@ -68,7 +66,7 @@ If you would like to contribute to the project you could do that in various ways
Since there is no CI set at the moment to perform automated testing, you are highly encouraged to test your contributions as much as possible and even contribute some unit tests if this aligns with your contributed content.
To try and maintain a coherent style in the codebase you are encouraged to use the template available in the [Templates](https://gitlab.com/in-nova/in-nova/-/tree/main/Templates?ref_type=heads) folder, although this is not necessary.
To try and maintain a coherent style in the codebase you are encouraged to use the template available in the [Templates](https://git.soton.ac.uk/in-nova/virtual-sensing/-/tree/main/Templates?ref_type=heads) folder, although this is not necessary.
Irrespective of style, it is highly advisable to name your variables in a meaningful manner and keep them as short as possible while still communicating their purpose. Comments are highly recommended in your code, especially where they can facilitate a better understanding of the code and the intent of the developer. Over-commented code is better than under-commented code.
......@@ -87,11 +85,11 @@ The project's "logo"/image has been generated with [DeepAI](https://deepai.org/)
## License
The project is licensed under the ***MIT License***, which is a rather unrestrictive license, effectively passing the code to the public scope. For more information see the [MIT License](https://mit-license.org/), or the [LICENSE](https://gitlab.com/in-nova/in-nova/-/blob/main/LICENSE?ref_type=heads) file of the project.
The project is licensed under the ***MIT License***, which is a rather unrestrictive license, effectively passing the code to the public scope. For more information see the [MIT License](https://mit-license.org/), or the [LICENSE](https://git.soton.ac.uk/in-nova/virtual-sensing/-/blob/main/LICENSE?ref_type=heads) file of the project.
## Versioning ##
The project uses [semantic versioning](https://semver.org/) and the current version is **v0.5.0**. The project hasn't reached v1.0.0 yet so changes that break backwards compatibility may (and have been) introduced in any version update. For information about the changes in each version consult the [CHANGELOG](https://gitlab.com/in-nova/in-nova/-/blob/main/CHANGELOG.md?ref_type=heads).
The project uses [semantic versioning](https://semver.org/) and the current version is **v0.5.0**. The project hasn't reached v1.0.0 yet so changes that break backwards compatibility may (and have been) introduced in any version update. For information about the changes in each version consult the [CHANGELOG](https://git.soton.ac.uk/in-nova/virtual-sensing/-/blob/main/CHANGELOG.md?ref_type=heads).
#### **Important**
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment