| Name | pymatroh JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | A python module to create random matrices. |
| upload_time | 2024-11-20 15:57:35 |
| maintainer | IT-Administrators |
| docs_url | None |
| author | IT-Administrators |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2024 IT-Administrators Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
matrix
random
int
integer
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pymatroh
_With the pymatroh module you can create different kind of matrices for testing purposes._
## Table of contents
1. [Introduction](#introduction)
2. [Getting started](#getting-started)
1. [Prerequisites](#prerequisites)
2. [Installation](#installation)
3. [How to use](#how-to-use)
1. [How to import](#how-to-import)
2. [Using the module](#using-the-module)
3. [Using the cli](#using-the-cli)
4. [Releasing](#releasing)
5. [License](/LICENSE)
## Introduction
The intention of this module is to create matrices of different kinds for testing purposes.
You can create only integer matrices, float or complex matrices. Mixing these values is currently not implemented.
## Getting started
### Prerequisites
- Python installed
- Operatingsystem: Linux or Windows, not tested on mac
- IDE like VS Code, if you want to contribute or change the code
### Installation
There are two ways to install this module depending on the way you work and the preinstalled modules:
1. ```pip install pymatroh```
2. ```python -m pip install pymatroh```
## How to use
### How to Import
You can import the module in two ways:
```python
import pymatroh
```
- This will import all functions. Even the ones that are not supposed to be used.
```python
from pymatroh import *
```
- This will import only the significant functions, meant for using.
### Using the module
Depending on the way you imported the module, the following examples look a bit different.
Example 1: Using ```import <modulename>```
```python
# Import module.
import pymatroh
# Create integer matrix with just one value.
im = pymatroh.Matrix(1,1)
print(im.create_int_matrix())
```
Result:
```
[[53]]
```
Example 2: Using ```from <modulename> import <submodule/class>```
```python
# Import class matrix from pymatroh package.
from pymatroh import Matrix
# Create float matrix.
fm = Matrix(2,2)
print(fm.create_float_matrix())
```
Result:
```python
[[0.3476066056691818, 82.64139933693019], [55.6682714565969, 37.442624968338635]]
```
Example 3: Using parameter applyround.
```python
# Import class matrix from pymatroh package.
from pymatroh import Matrix
# Create float matrix.
fm = Matrix(2,2,applyround=True)
print(fm.create_float_matrix())
```
Result:
```python
[[16.466, 24.297], [50.782, 36.962]]
```
### Using the cli
With the cli interface you can create python matrices and use them in scripts or export them to file
to use it in other projects.
To show the help run the following command:
```python
python -m pymatroh -h
```
Result:
```
usage: __main__.py [-h] [-row ROW] [-col COLUMN] [-rnge RANGE] [-mtype MATRIXTYPE] [-round ROUND]
options:
-h, --help show this help message and exit
Matrix:
-row ROW, --row ROW Row count.
-col COLUMN, --column COLUMN
Column count.
-rnge RANGE, --range RANGE
Integer range. Default = 100.
-mtype MATRIXTYPE, --matrixtype MATRIXTYPE
Type of matrix. You can specify int,float or complex.
-round ROUND, --round ROUND
Rounds the result by 3 digits.
```
Using the module via cli:
```
python -m pymatroh --row 2 --col 1 --round True --matrixtype float
```
Result:
```
[[69.856], [30.491]]
```
## Releasing
## License
[MIT](./LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "pymatroh",
"maintainer": "IT-Administrators",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "matrix, random, int, integer",
"author": "IT-Administrators",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/18/71/c4bd84a1329510b63734a45d4ec457e591335c495e218da4b1a017f0a71e/pymatroh-0.0.1.tar.gz",
"platform": null,
"description": "# pymatroh\r\n\r\n_With the pymatroh module you can create different kind of matrices for testing purposes._\r\n\r\n## Table of contents\r\n\r\n1. [Introduction](#introduction)\r\n2. [Getting started](#getting-started)\r\n 1. [Prerequisites](#prerequisites)\r\n 2. [Installation](#installation)\r\n3. [How to use](#how-to-use)\r\n 1. [How to import](#how-to-import)\r\n 2. [Using the module](#using-the-module)\r\n 3. [Using the cli](#using-the-cli)\r\n4. [Releasing](#releasing)\r\n5. [License](/LICENSE)\r\n\r\n## Introduction\r\n\r\nThe intention of this module is to create matrices of different kinds for testing purposes.\r\n\r\nYou can create only integer matrices, float or complex matrices. Mixing these values is currently not implemented.\r\n\r\n## Getting started\r\n\r\n### Prerequisites\r\n\r\n- Python installed\r\n- Operatingsystem: Linux or Windows, not tested on mac\r\n- IDE like VS Code, if you want to contribute or change the code\r\n\r\n### Installation\r\n\r\nThere are two ways to install this module depending on the way you work and the preinstalled modules:\r\n\r\n1. ```pip install pymatroh```\r\n\r\n2. ```python -m pip install pymatroh```\r\n\r\n## How to use\r\n\r\n### How to Import\r\n\r\nYou can import the module in two ways:\r\n\r\n```python\r\nimport pymatroh\r\n```\r\n\r\n- This will import all functions. Even the ones that are not supposed to be used.\r\n\r\n```python\r\nfrom pymatroh import *\r\n```\r\n\r\n- This will import only the significant functions, meant for using.\r\n\r\n### Using the module\r\n\r\nDepending on the way you imported the module, the following examples look a bit different.\r\n\r\nExample 1: Using ```import <modulename>```\r\n```python\r\n# Import module.\r\nimport pymatroh\r\n# Create integer matrix with just one value.\r\nim = pymatroh.Matrix(1,1)\r\nprint(im.create_int_matrix()) \r\n```\r\nResult:\r\n```\r\n[[53]]\r\n```\r\n\r\nExample 2: Using ```from <modulename> import <submodule/class>```\r\n```python\r\n# Import class matrix from pymatroh package.\r\nfrom pymatroh import Matrix\r\n# Create float matrix.\r\nfm = Matrix(2,2)\r\nprint(fm.create_float_matrix())\r\n```\r\nResult:\r\n```python\r\n[[0.3476066056691818, 82.64139933693019], [55.6682714565969, 37.442624968338635]]\r\n```\r\nExample 3: Using parameter applyround.\r\n```python\r\n# Import class matrix from pymatroh package.\r\nfrom pymatroh import Matrix\r\n# Create float matrix.\r\nfm = Matrix(2,2,applyround=True)\r\nprint(fm.create_float_matrix())\r\n```\r\nResult:\r\n```python\r\n[[16.466, 24.297], [50.782, 36.962]]\r\n```\r\n\r\n\r\n### Using the cli\r\n\r\nWith the cli interface you can create python matrices and use them in scripts or export them to file\r\nto use it in other projects.\r\n\r\nTo show the help run the following command:\r\n\r\n```python\r\npython -m pymatroh -h\r\n```\r\nResult:\r\n```\r\nusage: __main__.py [-h] [-row ROW] [-col COLUMN] [-rnge RANGE] [-mtype MATRIXTYPE] [-round ROUND]\r\n\r\noptions:\r\n -h, --help show this help message and exit\r\n\r\nMatrix:\r\n -row ROW, --row ROW Row count.\r\n -col COLUMN, --column COLUMN\r\n Column count.\r\n -rnge RANGE, --range RANGE\r\n Integer range. Default = 100.\r\n -mtype MATRIXTYPE, --matrixtype MATRIXTYPE\r\n Type of matrix. You can specify int,float or complex.\r\n -round ROUND, --round ROUND\r\n Rounds the result by 3 digits.\r\n```\r\nUsing the module via cli:\r\n```\r\npython -m pymatroh --row 2 --col 1 --round True --matrixtype float\r\n```\r\nResult:\r\n```\r\n[[69.856], [30.491]]\r\n```\r\n\r\n## Releasing\r\n\r\n## License\r\n\r\n[MIT](./LICENSE)\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 IT-Administrators Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A python module to create random matrices.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/IT-Administrators/pymatroh"
},
"split_keywords": [
"matrix",
" random",
" int",
" integer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92928e8c18ac7618911aa4615e7eb81b3c5ec1548b6ad38b3f89cbb70658d35d",
"md5": "f0e35e2d1afbd1c17d920b664c3f16f5",
"sha256": "673e4f67c35d78a0406a2c1b630efad80dc29a6538d9c967680370fee322d9bd"
},
"downloads": -1,
"filename": "pymatroh-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0e35e2d1afbd1c17d920b664c3f16f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5670,
"upload_time": "2024-11-20T15:57:33",
"upload_time_iso_8601": "2024-11-20T15:57:33.409646Z",
"url": "https://files.pythonhosted.org/packages/92/92/8e8c18ac7618911aa4615e7eb81b3c5ec1548b6ad38b3f89cbb70658d35d/pymatroh-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1871c4bd84a1329510b63734a45d4ec457e591335c495e218da4b1a017f0a71e",
"md5": "9146be749df866290513d0af1914002a",
"sha256": "be9eb2e1a6ee02a97b2b3647b0318e4d6a11a64089c6c569f392f029d6e76440"
},
"downloads": -1,
"filename": "pymatroh-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9146be749df866290513d0af1914002a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5491,
"upload_time": "2024-11-20T15:57:35",
"upload_time_iso_8601": "2024-11-20T15:57:35.755208Z",
"url": "https://files.pythonhosted.org/packages/18/71/c4bd84a1329510b63734a45d4ec457e591335c495e218da4b1a017f0a71e/pymatroh-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 15:57:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IT-Administrators",
"github_project": "pymatroh",
"github_not_found": true,
"lcname": "pymatroh"
}
