Skip to content

Commit

Permalink
ENH: Rename complex to simplnx (#801)
Browse files Browse the repository at this point in the history
The previous repo would have been at https://www.github.com/bluequartzsoftware/complex

Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson committed Dec 22, 2023
1 parent f340465 commit f1927c5
Show file tree
Hide file tree
Showing 1,904 changed files with 17,496 additions and 17,495 deletions.
2 changes: 1 addition & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"projectName": "complex",
"projectName": "simplnx",
"projectOwner": "BlueQuartzSoftware",
"repoType": "github",
"repoHost": "https://github.com",
Expand Down
4 changes: 2 additions & 2 deletions .clang-tidy
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ Checks: "-abseil-*,
-readability-uppercase-literal-suffix,
-readability-magic-numbers"
WarningsAsErrors: '*'
HeaderFilterRegex: 'complex/.*\.hpp'
HeaderFilterRegex: 'simplnx/.*\.hpp'
FormatStyle: file
CheckOptions:
cppcoreguidelines-macro-usage.AllowedRegexp: 'COMPLEX_EXPORT|COMPLEX_NO_EXPORT|COMPLEX_DEPRECATED'
cppcoreguidelines-macro-usage.AllowedRegexp: 'SIMPLNX_EXPORT|SIMPLNX_NO_EXPORT|SIMPLNX_DEPRECATED'
readability-identifier-naming.IgnoreMainLikeFunctions: 'false'
readability-identifier-naming.PrivateMemberPrefix: 'm_'
readability-identifier-naming.NamespaceCase: lower_case
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/functionality_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ body:
attributes:
label: Description of the Feature, Filter, or Functionality?
description: Describe your feature in detail or even provide an implementation plan/existing open source library to reference!
value: What if complex had...
value: What if simplnx had...
validations:
required: true
- type: dropdown
Expand Down
11 changes: 5 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- The text within this markup is a comment, and is intended to provide
guidelines to open a Pull Request for the complex repository. This text will not
guidelines to open a Pull Request for the simplnx repository. This text will not
be part of the Pull Request. -->


<!-- See the CONTRIBUTING (CONTRIBUTING.md) guide. Specifically:
Start complex commit messages with a standard prefix (and a space):
Start simplnx commit messages with a standard prefix (and a space):
* FILTER: When adding a new filter to code
* BUG: fix for runtime crash or incorrect result
Expand All @@ -29,15 +29,14 @@ close a related issues using keywords (https://help.github.com/articles/closing-
@mentions (https://help.github.com/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)
of the person or team responsible for reviewing proposed changes. -->


## Naming Conventions

Naming of variables should descriptive where needed. Loop Control Variables can use `i` if warranted. Most of these conventions are enforced through the clang-tidy and clang-format configuration files. See the file `complex/docs/Code_Style_Guide.md` for a more in depth explanation.
Naming of variables should descriptive where needed. Loop Control Variables can use `i` if warranted. Most of these conventions are enforced through the clang-tidy and clang-format configuration files. See the file `simplnx/docs/Code_Style_Guide.md` for a more in depth explanation.


## Filter Checklist

The help file `complex/docs/Porting_Filters.md` has documentation to help you port or write new filters. At the top is a nice checklist of items that should be noted when porting a filter.
The help file `simplnx/docs/Porting_Filters.md` has documentation to help you port or write new filters. At the top is a nice checklist of items that should be noted when porting a filter.


## Unit Testing
Expand All @@ -58,4 +57,4 @@ The idea of unit testing is to test the filter for proper execution and error ha
- [ ] Classes and methods are properly documented


<!-- **Thanks for contributing to complex!** -->
<!-- **Thanks for contributing to simplnx!** -->
1,192 changes: 596 additions & 596 deletions CMakeLists.txt

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions CMakePresets.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@
"type": "STRING",
"value": "Release"
},
"COMPLEX_BUILD_TESTS": {
"SIMPLNX_BUILD_TESTS": {
"type": "BOOL",
"value": "ON"
},
"COMPLEX_BUILD_DOCS": {
"SIMPLNX_BUILD_DOCS": {
"type": "BOOL",
"value": "OFF"
},
"COMPLEX_BUILD_PYTHON": {
"SIMPLNX_BUILD_PYTHON": {
"type": "BOOL",
"value": "ON"
},
"COMPLEX_EMBED_PYTHON": {
"SIMPLNX_EMBED_PYTHON": {
"type": "BOOL",
"value": "OFF"
},
Expand Down Expand Up @@ -167,43 +167,43 @@
"type": "STRING",
"value": "Release"
},
"COMPLEX_BUILD_TESTS": {
"SIMPLNX_BUILD_TESTS": {
"type": "BOOL",
"value": "OFF"
},
"COMPLEX_BUILD_DOCS": {
"SIMPLNX_BUILD_DOCS": {
"type": "BOOL",
"value": "OFF"
},
"COMPLEX_BUILD_PYTHON": {
"SIMPLNX_BUILD_PYTHON": {
"type": "BOOL",
"value": "ON"
},
"COMPLEX_EMBED_PYTHON": {
"SIMPLNX_EMBED_PYTHON": {
"type": "BOOL",
"value": "ON"
},
"COMPLEX_DOWNLOAD_TEST_FILES": {
"SIMPLNX_DOWNLOAD_TEST_FILES": {
"type": "BOOL",
"value": "OFF"
},
"COMPLEX_CONDA_BUILD": {
"SIMPLNX_CONDA_BUILD": {
"type": "BOOL",
"value": "ON"
},
"COMPLEX_ENABLE_INSTALL": {
"SIMPLNX_ENABLE_INSTALL": {
"type": "BOOL",
"value": "ON"
},
"COMPLEX_PY_ENABLE_INSTALL": {
"SIMPLNX_PY_ENABLE_INSTALL": {
"type": "BOOL",
"value": "ON"
},
"COMPLEX_PY_INSTALL_DIR": {
"SIMPLNX_PY_INSTALL_DIR": {
"type": "PATH",
"value": "$env{SP_DIR}"
},
"COMPLEX_PY_GENERATE_PYI": {
"SIMPLNX_PY_GENERATE_PYI": {
"type": "BOOL",
"value": "ON"
},
Expand All @@ -215,7 +215,7 @@
"type": "BOOL",
"value": "OFF"
},
"ComplexCore_INSTALL_PIPELINES": {
"SimplnxCore_INSTALL_PIPELINES": {
"type": "BOOL",
"value": "OFF"
},
Expand Down Expand Up @@ -275,7 +275,7 @@
"name": "conda-osx",
"inherits": "conda-unix",
"cacheVariables": {
"COMPLEX_PY_DISABLE_HIDDEN_VISIBILITY": {
"SIMPLNX_PY_DISABLE_HIDDEN_VISIBILITY": {
"type": "BOOL",
"value": "ON"
}
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Code of Conduct for complex
# Code of Conduct for simplnx

## 1. Introduction

Expand Down
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing Guide

Thank you for considering contributing to complex. Your involvement helps make complex a valuable tool for the global scientific community.
Thank you for considering contributing to simplnx. Your involvement helps make simplnx a valuable tool for the global scientific community.

This repository needs many different kinds of contribution not all of which require coding knowledge. Here are some of the different options:

Expand All @@ -14,18 +14,18 @@ This repository needs many different kinds of contribution not all of which requ
- Answer questions from fellow users in [DREAM3DNX-Issues discussions](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues/discussions)
- **For Python Developers:**
- Create new examples of use cases and as a Jupyter Notebook or sdd to documentation
- Create filters for complex from new papers and dissertations
- Create filters for simplnx from new papers and dissertations
- Fix bugs in filters or the python bindings
- Update exisitng filters to expand functionality or optimize
- **For Operating System Power Users and CyberSecurity Experts:**
- Report security vulnerabilities in [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues)
- Add CMake presets for compiling on unique operating systems not already supported
- Create packages of DREAM3DNX and/or complex (with the nxrunner cli) and submit them to your favorite package manager (AUR, Flatpak, etc.)
- Create ways to run complex (with the nxrunner cli) in containers (such as Docker container)
- Create packages of DREAM3DNX and/or simplnx (with the nxrunner cli) and submit them to your favorite package manager (AUR, Flatpak, etc.)
- Create ways to run simplnx (with the nxrunner cli) in containers (such as Docker container)
- **For C++ Developers:**
- Create new filters for complex from new papers and dissertations
- Port old SIMPL filters to the updated complex framework [porting filters guidelines](/docs/Porting_Filters.md)
- Handle bugs and feature requests: [issue tracker](https://github.com/bluequartzsoftware/complex/issues)
- Create new filters for simplnx from new papers and dissertations
- Port old SIMPL filters to the updated simplnx framework [porting filters guidelines](/docs/Porting_Filters.md)
- Handle bugs and feature requests: [issue tracker](https://github.com/bluequartzsoftware/simplnx/issues)
- Create new test cases to improve the reliability and robustness of the filters
- Update nxrunner cli to offer the same functionality as our GUI interface
- Optimize existing filter algorithms
Expand All @@ -40,11 +40,11 @@ For instructions on building from source see our [Guide to Building From Source]
## Getting Started

1. Fork the repository to your GitHub account.
2. Clone the repository to your local machine: `git clone https://github.com/YOUR_USERNAME/complex.git`
2. Clone the repository to your local machine: `git clone https://github.com/YOUR_USERNAME/simplnx.git`
3. Create a new branch: `git checkout -b NAME_YOUR_BRANCH`
4. Make your changes and commit them: `git commit -m 'Add some feature or fix some issue'`
5. Push your changes to your fork: `git push origin NAME_YOUR_BRANCH`
6. Create a pull request from your branch to the complex `main` or `master` branch.
6. Create a pull request from your branch to the simplnx `main` or `master` branch.

## Code of Conduct

Expand All @@ -56,17 +56,17 @@ If you experience or witness unacceptable behavior—or have any other concerns

### Reporting Bugs

1. Check the [issue tracker](https://github.com/bluequartzsoftware/complex/issues) to ensure the bug hasn't already been reported.
1. Check the [issue tracker](https://github.com/bluequartzsoftware/simplnx/issues) to ensure the bug hasn't already been reported.
2. If the bug hasn't been reported, create a new issue. Provide a clear description of the problem, including steps to reproduce.

### Suggesting Enhancements

1. Check the [issue tracker](https://github.com/bluequartzsoftware/complex/issues) to ensure the enhancement hasn't already been suggested.
1. Check the [issue tracker](https://github.com/bluequartzsoftware/simplnx/issues) to ensure the enhancement hasn't already been suggested.
2. If not, create a new issue. Provide a clear description of the enhancement.

### Handling Issues with Help Wanted Tag

1. Check the [issue tracker](https://github.com/bluequartzsoftware/complex/issues) and sort by Help Wanted to see issues that aren't actively being handled internally.
1. Check the [issue tracker](https://github.com/bluequartzsoftware/simplnx/issues) and sort by Help Wanted to see issues that aren't actively being handled internally.
2. Once you select an issue, check for existing comments containing an "In Progress" title.
3. If there is not an exitisting _In Progress_ comment proceed to step 4, else do the following:
- Check the _Description of Planned Changes_ in the comment to see if the part of they are already handling the change you want to make. If not continue to step 4
Expand Down Expand Up @@ -117,9 +117,9 @@ Willing to Collaborate with Other Contributors on These Changes: Y/N

For information about our specifc naming conventions and styling see our [coding style guide](/docs/Code_Style_Guide.md).

For the basic code styling complex uses `clang-format`, the formatting file is included at the root level in the repository.
For the basic code styling simplnx uses `clang-format`, the formatting file is included at the root level in the repository.

`clang-format` is a tool to automatically format C++ code. You should run 'clang-format' on your code before opening a Pull Request to make sure it passes the _clang-format pr_ check. You can install `clang-format` and `git-clang-format` with `npm install -g clang-format`. To automatically format a file according to a project's C++ code style, run `clang-format -i path/to/complex/file`, which is supported on macOS/Linux/Windows. If you want to run `clang-format` on all the changed code on your latest git commit (HEAD), you can run `git-clang-format HEAD~1`. Run `git-clang-format -h` for extra help.
`clang-format` is a tool to automatically format C++ code. You should run 'clang-format' on your code before opening a Pull Request to make sure it passes the _clang-format pr_ check. You can install `clang-format` and `git-clang-format` with `npm install -g clang-format`. To automatically format a file according to a project's C++ code style, run `clang-format -i path/to/simplnx/file`, which is supported on macOS/Linux/Windows. If you want to run `clang-format` on all the changed code on your latest git commit (HEAD), you can run `git-clang-format HEAD~1`. Run `git-clang-format -h` for extra help.

### Documentation Styleguide

Expand Down
18 changes: 9 additions & 9 deletions PortingFilters.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ Some nuances to note for this are as follows:
<ul>
<li>The path to the plugin should be .../PluginName/ NOT .../PluginName/src/PluginName/</li>
<li>The slash at the end of the filepath is necessary to work properly ie [.../PluginName/ NOT .../PluginName]</li>
<li>The name of the filter should be the SIMPL name not what you want the complex name to be</li>
<li>The name of the filter should be the SIMPL name not what you want the simplnx name to be</li>
</ul>

You will need to update the various CMake files inside the target complex plugin in order to start compiling the new filter code inside of a complex build.
You will need to update the various CMake files inside the target simplnx plugin in order to start compiling the new filter code inside of a simplnx build.


## SECTION 2 : Porting stubs from existing folder to ***Filters Folder***
Expand Down Expand Up @@ -91,26 +91,26 @@ Files from current SIMPL DREAM3D should have the prefix "6_6_" which denotes the
These will be used to verify changes in the file and look for updates.

> Go to the complex GitHub repo and update with the tar.gz file
> Go to the simplnx GitHub repo and update with the tar.gz file
GitHub Repo : <https://github.com/BlueQuartzSoftware/complex/releases/tag/Data_Archive>
GitHub Repo : <https://github.com/bluequartzsoftware/simplnx/releases/tag/Data_Archive>
**Be Sure to Save the Release**

> Go to the complex CMakeLists.txt file and update sha 512
> Go to the simplnx CMakeLists.txt file and update sha 512
Located at line 579 in the CMakeLists.text file in the ***complex*** repo, one must update the table accordingly.
Located at line 579 in the CMakeLists.text file in the ***simplnx*** repo, one must update the table accordingly.

### Working with filters outside the current plugin

There will be times you may have to call upon filters from another repo. Typically this occurs in ***complex_plugins***. In order to do this one must create an application instance which is done so by wrapping it in a struct that gets nested in a shared pointer to make sure it cleans itself up after each test case. Here is the syntax for doing so:
There will be times you may have to call upon filters from another repo. Typically this occurs in ***simplnx_plugins***. In order to do this one must create an application instance which is done so by wrapping it in a struct that gets nested in a shared pointer to make sure it cleans itself up after each test case. Here is the syntax for doing so:

> std::shared_ptr<UnitTest::make_shared_enabler> app = std::make_shared<UnitTest::make_shared_enabler>();
> app->loadPlugins(unit_test::k_BuildDir.view(), true);
> auto* filterList = Application::Instance()->getFilterList();
To use make_shared_enabler you must include:

> #include "complex/UnitTest/UnitTestCommon.hpp"
> #include "simplnx/UnitTest/UnitTestCommon.hpp"
The syntax for use of ***filterList*** is as follows:

Expand Down Expand Up @@ -200,7 +200,7 @@ The number at the start is an arbitrary value save for the fact it must be negat

## SECTION 6 : Utilizing API's to the fullest

This section aims to tackle ***complex*** convenience functions from major API's:
This section aims to tackle ***simplnx*** convenience functions from major API's:

### Utilizing the ExecuteDataFunction

Expand Down
Loading

0 comments on commit f1927c5

Please sign in to comment.