Add the initial files for north tool.

[RubelMozumder]

No description provided.

[coveralls]

Pull Request Test Coverage Report for Build 21070715826

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 91.837%

---

Totals
Change from base Build 20129629698:	0.0%
Covered Lines:	45
Relevant Lines:	49

---

💛 - Coveralls

[lukaspie]

I wonder if we could follow the structure that Lauri suggested:

src/<plugin-name>/north_tools/_<tool_name>/__init__.py # Contains definitions and entry point
src/<plugin-name>/north_tools/<tool_name> # Contains e.g. the Docker file and all other assets for the tool.

Or for the pynxtools-plugin case,

src/pynxtools_FOO/nomad/north_tools/_<tool_name>/__init__.py # Contains definitions and entry point
src/pynxtools_FOO/north_tools/<tool_name> # Contains e.g. the Dockerfile and all other assets for the tool.

That would possible keep the root level of the plugin much cleaner and align with how we define the other plugins. What do you think @RubelMozumder?

[RubelMozumder]

I wonder if we could follow the structure that Lauri suggested:

src/<plugin-name>/north_tools/_<tool_name>/__init__.py # Contains definitions and entry point
src/<plugin-name>/north_tools/<tool_name> # Contains e.g. the Docker file and all other assets for the tool.

Or for the pynxtools-plugin case,

src/pynxtools_FOO/nomad/north_tools/_<tool_name>/__init__.py # Contains definitions and entry point
src/pynxtools_FOO/north_tools/<tool_name> # Contains e.g. the Dockerfile and all other assets for the tool.

That would possible keep the root level of the plugin much cleaner and align with how we define the other plugins. What do you think @RubelMozumder?

The common structure is like that. It is also possible to include multiple notebooks for testing in the test section.
We may think of keeping the Docker file in docker directory in the root folder if there are multiple Docker files. If we leave the Dockerfile inside the package (src dir), the files will be shipped with the package without any practical usage.

[RubelMozumder]

follow #71