{"_id":"@de-marauder/gen-algo","_rev":"2-0cc021a69a6f03f975c27c602457a76d","name":"@de-marauder/gen-algo","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@de-marauder/gen-algo","version":"0.0.1","keywords":["genetics","algorithm","optimization","gen-algo","de-marauder"],"author":{"url":"https://de-marauder.vercel.app","name":"de-marauder","email":"ezikegodson@gmail.com"},"license":"MIT","_id":"@de-marauder/gen-algo@0.0.1","maintainers":[{"name":"de-marauder","email":"ezikegodson@gmail.com"}],"bin":{"gen-algo":"bin/cli/index.js"},"dist":{"shasum":"09552cab58b15cf0facd5243bfba633838acf26e","tarball":"https://registry.npmjs.org/@de-marauder/gen-algo/-/gen-algo-0.0.1.tgz","fileCount":18,"integrity":"sha512-gnG5PGe21w+oYgYe84L1UMOG1xIBeO0QZTf0GVNjLr9EBKzQ0uTz3Vr6uNjPl/EwGEL5DSTtf8W69Zo8SmN+uw==","signatures":[{"sig":"MEUCIAkLDxjzU5GGSv/6MyXuuOOFWhDGb7Rg9MWHTp+JduPeAiEAhpfAYVTfXfSfEAvDQ/aOwPUEs8L/wLpuhk9rFoGOmqE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":67346},"gitHead":"af1c7ad5ac58a8240c939a950b1530af54185d48","scripts":{"dev":"npm run create-default-config && tsc -p . --watch","build":"npm run create-default-config && tsc -p .","start":"npm run create-default-config && node bin/cli/index.js","format":"prettier --write \"./**/*.{ts,js,json}\"","create-default-config":"mkdir -p $HOME/.gen-algo/config && cp ./Algorithm/defaultConfig.yaml $HOME/.gen-algo/config/"},"_npmUser":{"name":"de-marauder","email":"ezikegodson@gmail.com"},"_npmVersion":"8.19.2","description":"Genetics algorithm for optimizing steam methane reforming reaction for higher production on hydrogen","directories":{},"_nodeVersion":"18.10.0","dependencies":{"meow":"^9.0.0","chalk":"^4.1.2","js-yaml":"^4.1.0","commander":"^11.0.0","randomatic":"^3.1.1","typescript":"^5.1.6","cli-welcome":"^2.2.2","@types/js-yaml":"^4.0.5"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.46.0","ts-node":"^10.9.1","prettier":"^3.0.2","@types/node":"^20.4.9","@types/randomatic":"^3.1.3","@types/cli-welcome":"^2.2.0","@typescript-eslint/eslint-plugin":"^6.2.1"},"_npmOperationalInternal":{"tmp":"tmp/gen-algo_0.0.1_1704188487778_0.12035454309100002","host":"s3://npm-registry-packages"}},"0.0.2":{"name":"@de-marauder/gen-algo","description":"Genetics algorithm for optimizing steam methane reforming reaction for higher production on hydrogen","version":"0.0.2","license":"MIT","bin":{"gen-algo":"bin/cli/index.js"},"author":{"name":"de-marauder","email":"ezikegodson@gmail.com","url":"https://de-marauder.vercel.app"},"keywords":["genetics","algorithm","optimization","gen-algo","de-marauder"],"scripts":{"start":"npm run create-default-config && node bin/cli/index.js","create-default-config":"mkdir -p $HOME/.gen-algo/config && cp ./Algorithm/defaultConfig.yaml $HOME/.gen-algo/config/","dev":"npm run create-default-config && tsc -p . --watch","build":"npm run create-default-config && tsc -p .","format":"prettier --write \"./**/*.{ts,js,json}\""},"dependencies":{"@types/js-yaml":"^4.0.5","chalk":"^4.1.2","cli-welcome":"^2.2.2","commander":"^11.0.0","js-yaml":"^4.1.0","meow":"^9.0.0","randomatic":"^3.1.1","typescript":"^5.1.6"},"devDependencies":{"@types/cli-welcome":"^2.2.0","@types/node":"^20.4.9","@types/randomatic":"^3.1.3","@typescript-eslint/eslint-plugin":"^6.2.1","eslint":"^8.46.0","prettier":"^3.0.2","ts-node":"^10.9.1"},"_id":"@de-marauder/gen-algo@0.0.2","gitHead":"a29cdb4c65a211f7c0ef11b6eae8a412a2d60b05","_nodeVersion":"18.20.8","_npmVersion":"10.8.2","dist":{"integrity":"sha512-9TrSAoysZL+WpcXw2kdfi829NKK4Cm09UpSZi0zUSBV2K44Ja+hUVqEflPcYd04S/9/t6V81UTZ4BLc6xUwCwQ==","shasum":"1a4267fd28cc3ba4f5fa5cd240a20a3335bb7b36","tarball":"https://registry.npmjs.org/@de-marauder/gen-algo/-/gen-algo-0.0.2.tgz","fileCount":2,"unpackedSize":3945,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD/TVvAzjsLr8Bj5FKxHamoQbeKP91L4cjzy7GxLiL5xQIgSUQxlcAYEVNq8ETmg6/+rdrL3YCpeLtK4sUraJkP42s="}]},"_npmUser":{"name":"de-marauder","email":"ezikegodson@gmail.com"},"directories":{},"maintainers":[{"name":"de-marauder","email":"ezikegodson@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/gen-algo_0.0.2_1764939628306_0.7245462954298263"},"_hasShrinkwrap":false}},"time":{"created":"2024-01-02T09:41:27.680Z","modified":"2025-12-05T13:00:28.655Z","0.0.1":"2024-01-02T09:41:28.071Z","0.0.2":"2025-12-05T13:00:28.439Z"},"author":{"name":"de-marauder","email":"ezikegodson@gmail.com","url":"https://de-marauder.vercel.app"},"license":"MIT","keywords":["genetics","algorithm","optimization","gen-algo","de-marauder"],"description":"Genetics algorithm for optimizing steam methane reforming reaction for higher production on hydrogen","maintainers":[{"name":"de-marauder","email":"ezikegodson@gmail.com"}],"readme":"# Gen Algo CLI\n\nA nodeJs based CLI for running a genetic algorithm to optimize hydrogen production from a given flare gas using a Steam Methane Reformer\n\n## Build Instructions\n```bash\ncd path/to/repo\nnpm run build\nnpm link\n```\n- The first npm command builds the CLI; compiling the typescript code down to javascript and also creates some directories and files to allow the CLI operate properly\n- The second npm command make the package available at a global level (kinda like installing it globally). This allows you to run the command `gen-algo` to use the application\n\n## How to Use\n### Base command\n```bash\nUsage: gen-algo [options] [command]\n\nOptions:\n  -V, --version            output the version number\n  -h, --help               display help for command\n\nCommands:\n  update-config [options]  Update current configuration\n  show-config              Show current configuration\n  run [options]            Run algorithm with config at $HOME/.gen-algo/config/defaultConfig.yaml\n  help [command]           display help for command\n```\n\n### Run command\n```bash\nUsage: gen-algo run [options]\n\nRun algorithm with config at $HOME/.gen-algo/config/defaultConfig.yaml\n\nOptions:\n  -o, --outdir <path-to-output-file>    Absolute path to output file (default: \"$HOME/output.txt\")\n  --config, <path-to-config-yaml-file>  Absolute path to config file (default: \"$HOME/.gen-algo/config/defaultConfig.yaml\")\n  -h, --help                            display help for command\n```\n\n### Update Config\n```bash\nUsage: gen-algo update-config [options]\n\nUpdate current configuration\n\nOptions:\n  -p --path <string - path-to-file>  Path to configuration file\n  -h, --help                         display help for command\n```\n\n### Show Current Config\n```bash\nUsage: gen-algo show-config [options]\n\nShow current configuration\n\nOptions:\n  -h, --help  display help for command\n```\n\n## Debugging\nAlways remember to run the help commands for information on how to use the CLI\n```bash\ngen-algo [command] --help\n```\nor\n```bash\ngen-algo help\n```\n\nTo update your configuration, you can copy the file at `$HOME/.gen-algo/config/defaultConfig.yaml` and make changes to it. Then supply the path of the changed file to the `update-config` command\n```bash\ncp $HOME/.gen-algo/config/defaultConfig.yaml path/to/copy/file/to\ngen-algo update-config -p path/to/copied-and-updated/config-file\n```\n\nAfter running the algorithm, the results are written to an `output.txt` file in the current working directory\n\n## Notes\nCheckt out the [WebUI](https://gen-algo-webui.vercel.app/) to have visualisations, more intuitive layout and persistence of successive runs","readmeFilename":"README.md"}