Skip to content

Mapping files between Mapped and Willow ontologies. The mapping files can be directly used by opendigitaltwins-tools as well

License

Notifications You must be signed in to change notification settings

mapped/mapped-willow-mapping

Repository files navigation

mapped-willow-mapping

Setting Up the Environment

.NET for Testing

  1. Install .NET: Download and install from the .NET official website.

Pre-Commit Hooks

  1. Install Pre-Commit: Follow the installation guide on the Pre-Commit website.
  2. Activate Hooks: Run pre-commit install in your repository.

Python and Poetry

  1. Install Python: Download and install Python from the Python official website.
  2. Install Poetry: Follow the instructions on the Poetry website.
  3. Install Dependencies: Inside your project directory, run poetry install to install all required Python dependencies in a virtual environment managed by Poetry.
  4. Activate Poetry Virtual Environment: Execute poetry shell in the project directory to start the virtual environment.

Contributing

Adding to Manual Mapping Files

  • Add your manual mappings to the ./data directory, which is the central location for all manual mapping files.

Local Testing

  1. Generate Inferred Mappings:

    • Before running the tests, it's important to generate the inferred mappings. This can be done by executing the following Python script:
      python ./scripts/generate_mappings.py
      
    • This script will create the inferred mappings and place them in the appropriate directory.
  2. Build the Project:

    • Once the inferred mappings are generated, the next step is to build the dotnet project. This prepares the project for running tests. Use the command:
      dotnet build
      
  3. Run the Tests:

    • After building the project, run the tests to check the integrity and functionality of your code. Execute:
      dotnet test Ontologies.Mappings/test/Ontologies.Mappings.Test.csproj
      

By following these steps, you can perform local testing, ensuring that both the nferred mappings work correctly.

Pre-Commit Hook Preparation

  • Before committing your code, ensure you have set up pre-commit hooks as described in the environment setup section.

Additional Resources

About

Mapping files between Mapped and Willow ontologies. The mapping files can be directly used by opendigitaltwins-tools as well

Resources

License

Stars

Watchers

Forks

Packages

No packages published