Merge pull request #7 from Mahmoud-Yasser-18/nix

Adding Nix derivation to the OQD compiler infrastructure

Author: Mahmoud-Yasser-18

.envrc

@@ -0,0 +1 @@
+use flake

README.md

@@ -32,6 +32,55 @@ or alternatively from `git`:
 pip install git+https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure.git
 ```
 
+### Installation with Nix
+
+You can use this package with Nix in several ways:
+
+1. Using the development environment:
+```bash
+# Clone the repository
+git clone https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure.git
+cd oqd-compiler-infrastructure
+
+# Enter the development shell
+nix develop
+```
+
+2. Building the package:
+```bash
+nix build github:OpenQuantumDesign/oqd-compiler-infrastructure
+```
+
+### Using in Your Nix Projects
+
+To use this package in your own Nix project, you can add it to your `flake.nix`:
+
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    oqd-compiler.url = "github:OpenQuantumDesign/oqd-compiler-infrastructure";
+  };
+
+  outputs = { self, nixpkgs, oqd-compiler }: {
+    # For using in a development shell
+    devShells.x86_64-linux.default = nixpkgs.legacyPackages.x86_64-linux.mkShell {
+      buildInputs = [
+        oqd-compiler.packages.x86_64-linux.default
+      ];
+    };
+
+    # For using as a dependency in your package
+    packages.x86_64-linux.default = nixpkgs.legacyPackages.x86_64-linux.python3Packages.buildPythonPackage {
+      # ... your package configuration ...
+      propagatedBuildInputs = [
+        oqd-compiler.packages.x86_64-linux.default
+      ];
+    };
+  };
+}
+```
+
 For development, clone the repository locally:
 
 ```bash

flake.lock

@@ -0,0 +1,68 @@
+# Copyright 2024-2025 Open Quantum Design
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+{
+  description = "OpenQuantum Design Compiler Infrastructure";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+        python = pkgs.python311;
+        pythonPackages = python.pkgs;
+      in
+      {
+        packages.default = pythonPackages.callPackage ./pkgs/derivation.nix { };
+
+        devShells.default = pkgs.mkShell {
+          packages = with pkgs; [
+            # Python with dependencies
+            (python.withPackages (ps: with ps; [
+              # Core dependencies
+              pydantic
+
+              # Documentation dependencies
+              pymdown-extensions
+              mkdocstrings
+              mkdocs-material
+              mkdocstrings-python
+              mdx-truly-sane-lists
+
+              # Test dependencies
+              pytest
+
+              # Development tools
+              pip
+              black
+              isort
+              mypy
+            ]))
+
+            # Additional development tools
+            git
+          ];
+
+          shellHook = ''
+            export PYTHONPATH="$PWD/src:$PYTHONPATH"
+            echo "OpenQuantum Design Compiler Infrastructure development environment"
+            echo "Python version: $(python --version)"
+          '';
+        };
+      }
+    );
+}

flake.nix

@@ -0,0 +1,59 @@
+# Copyright 2024-2025 Open Quantum Design
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+{ lib
+, buildPythonPackage
+, pythonOlder
+, pydantic
+, pytest
+, pymdown-extensions
+, mkdocstrings
+, mkdocs-material
+, mkdocstrings-python
+, mdx-truly-sane-lists
+}:
+
+buildPythonPackage rec {
+  pname = "oqd-compiler-infrastructure";
+  version = "0.1.0";
+  format = "pyproject";
+
+  disabled = pythonOlder "3.10";
+
+  src = ./..;
+
+  propagatedBuildInputs = [
+    pydantic
+  ];
+
+  checkInputs = [
+    pytest
+  ];
+
+  nativeBuildInputs = [
+    pymdown-extensions
+    mkdocstrings
+    mkdocs-material
+    mkdocstrings-python
+  ];
+
+  pythonImportsCheck = [ "oqd_compiler_infrastructure" ];
+
+  meta = with lib; {
+    description = "OpenQuantum Design Compiler Infrastructure";
+    homepage = "https://github.com/OpenQuantumDesign/oqd-compiler-infrastructure";
+    license = licenses.apache20;
+    maintainers = with maintainers; [ ];
+  };
+}