Arenz-Group-Python


NameArenz-Group-Python JSON
Version 0.3.9 PyPI version JSON
download
home_pageNone
Summarya pip-installable package with function for Arenz Group
upload_time2024-10-24 15:34:13
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseMIT License Copyright (c) 2024 Gustav Wiberg 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 arenz group python tdms
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Arenz_Group_Python
Python libs for NanoElectroCatalysis.

## The aim
 - Create a standard project folder structure.
 - Easy transfer of data from server to local folder for work-up
 - Load and save key-values-pairs
 - Load and save key-values-pairs into tables.
 - Path constants for easy access to data folders.




## Documentation

https://nanoelectrocatalysis.github.io/Arenz_Group_Python/

# Get started
In the project root folder, create a jupyter file.

## Package installation or upgrade using Jupyter

In order to install this package use the following line in a jupyter notebook: 
```python
%pip install arenz_group_python
```
In order to upgrade this package use the following line in a jupyter notebook: 

```python
%pip install arenz_group_python -U
```

Restart the kernal.

## Create the basic project folder structure.

```python
from arenz_group_python import Project_Paths 
pp = Project_Paths()
pp.create_project_structure()
```

## Import raw data files.
Make sure that all the folders you want to import as a file called:
<IDENTIFYIER>.tag 
where <IDENTIFYIER> can be a project name, example: "project.tag"

```python
from arenz_group_python import Project_Paths
pp = Project_Paths()
project_name = 'projectname'
user_initials = '' #This is optional, but it can speed up things
path_to_server = 'X:/EXP_DB'
pp.copyDirs(project_name, user_initials , path_to_server)
```

## Examples
See documentation.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "Arenz-Group-Python",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "Gustav Wiberg <gustav.wiberg@unibe.ch>",
    "keywords": "arenz group, python, tdms",
    "author": null,
    "author_email": "Gustav Wiberg <gustav.wiberg@unibe.ch>",
    "download_url": "https://files.pythonhosted.org/packages/bd/5a/9a0b2a827074186e262fcce8e924d8a6bca1b5313b488023d31a9c02a936/arenz_group_python-0.3.9.tar.gz",
    "platform": null,
    "description": "# Arenz_Group_Python\nPython libs for NanoElectroCatalysis.\n\n## The aim\n - Create a standard project folder structure.\n - Easy transfer of data from server to local folder for work-up\n - Load and save key-values-pairs\n - Load and save key-values-pairs into tables.\n - Path constants for easy access to data folders.\n\n\n\n\n## Documentation\n\nhttps://nanoelectrocatalysis.github.io/Arenz_Group_Python/\n\n# Get started\nIn the project root folder, create a jupyter file.\n\n## Package installation or upgrade using Jupyter\n\nIn order to install this package use the following line in a jupyter notebook: \n```python\n%pip install arenz_group_python\n```\nIn order to upgrade this package use the following line in a jupyter notebook: \n\n```python\n%pip install arenz_group_python -U\n```\n\nRestart the kernal.\n\n## Create the basic project folder structure.\n\n```python\nfrom arenz_group_python import Project_Paths \npp = Project_Paths()\npp.create_project_structure()\n```\n\n## Import raw data files.\nMake sure that all the folders you want to import as a file called:\n<IDENTIFYIER>.tag \nwhere <IDENTIFYIER> can be a project name, example: \"project.tag\"\n\n```python\nfrom arenz_group_python import Project_Paths\npp = Project_Paths()\nproject_name = 'projectname'\nuser_initials = '' #This is optional, but it can speed up things\npath_to_server = 'X:/EXP_DB'\npp.copyDirs(project_name, user_initials , path_to_server)\n```\n\n## Examples\nSee documentation.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Gustav Wiberg  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 pip-installable package with function for Arenz Group",
    "version": "0.3.9",
    "project_urls": {
        "Changelog": "https://github.com/NanoElectroCatalysis/Arenz_Group_Python",
        "Documentation": "https://nanoelectrocatalysis.github.io/Arenz_Group_Python",
        "Homepage": "https://github.com/NanoElectroCatalysis/Arenz_Group_Python",
        "Issues": "https://github.com/NanoElectroCatalysis/Arenz_Group_Python",
        "Repository": "https://github.com/NanoElectroCatalysis/Arenz_Group_Python"
    },
    "split_keywords": [
        "arenz group",
        " python",
        " tdms"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4348954e5a8e58c0127137c92ea966a1b685d0ccd3295d432059f3184b323715",
                "md5": "d6957d4e3f919d4e711f7a2b52e2ee85",
                "sha256": "7a6bb9c99f4223b1ac990eddccfa25195152f33f2aca4eda23519e17992d2c4c"
            },
            "downloads": -1,
            "filename": "arenz_group_python-0.3.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6957d4e3f919d4e711f7a2b52e2ee85",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 34011,
            "upload_time": "2024-10-24T15:34:11",
            "upload_time_iso_8601": "2024-10-24T15:34:11.213020Z",
            "url": "https://files.pythonhosted.org/packages/43/48/954e5a8e58c0127137c92ea966a1b685d0ccd3295d432059f3184b323715/arenz_group_python-0.3.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd5a9a0b2a827074186e262fcce8e924d8a6bca1b5313b488023d31a9c02a936",
                "md5": "b88724d85e678091d131465fc9794fe4",
                "sha256": "49dc136fad368903bc90d02e5c5e5eb9765a4911e238d8096717f943c555780f"
            },
            "downloads": -1,
            "filename": "arenz_group_python-0.3.9.tar.gz",
            "has_sig": false,
            "md5_digest": "b88724d85e678091d131465fc9794fe4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 36933480,
            "upload_time": "2024-10-24T15:34:13",
            "upload_time_iso_8601": "2024-10-24T15:34:13.148177Z",
            "url": "https://files.pythonhosted.org/packages/bd/5a/9a0b2a827074186e262fcce8e924d8a6bca1b5313b488023d31a9c02a936/arenz_group_python-0.3.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-24 15:34:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NanoElectroCatalysis",
    "github_project": "Arenz_Group_Python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "arenz-group-python"
}
        
Elapsed time: 0.40710s