Metadata-Version: 2.4
Name: pysdb3
Version: 3.2.1
Summary: SDB structural database manager
Project-URL: Homepage, https://github.com/ondrolexa/pysdb
Project-URL: Repository, https://github.com/ondrolexa/pysdb.git
Project-URL: Issues, https://github.com/ondrolexa/pysdb/issues
Author-email: Ondrej Lexa <lexa.ondrej@gmail.com>
Maintainer-email: Ondrej Lexa <lexa.ondrej@gmail.com>
License: MIT License
        
        Copyright (c) 2021 Ondrej Lexa
        
        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.
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: lxml
Requires-Dist: pyqt5
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Description-Content-Type: text/markdown

# pysdb - python structural database

GUI front-end to create, edit and manage the field structural geology data in sqlite3 file database
(SDB structural database). This database format is compatible with [readsdb QGIS3 plugin](https://github.com/ondrolexa/readsdb).

For advanced analyses and visualization, it could be used with [APSG](https://github.com/ondrolexa/apsg).

## How to install

It is strongly suggested to install **pysdb** into separate environment. You can create
Python virtual environment. For Linux and macOS use:

    python -m venv .venv
    source .venv/bin/activate

for Windows use Command Prompt or PowerShell:

    python -m venv .venv
    .venv\Scripts\activate

> [!NOTE]
> On Microsoft Windows, it may be required to set the execution policy in PowerShell for the user.
> You can do this by issuing the following PowerShell command:
> ```
> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
> ```

and install **pysdb** using pip within the environment:

    pip install pysdb3

## I'm using conda or mamba to manage environments

If you have already have conda or mamba installed, you can create environment with:

    conda create -n pysdb python pyqt lxml

or

    mamba create -n pysdb python pyqt lxml

Then activate the new environment:

    conda activate pysdb

or

    mamba activate pysdb

and install with pip:

    pip install pysdb3

> [!NOTE]
> If you encounter errors during install, try to install without upgrading dependencies:
> ```
> pip install --no-deps pysdb3
> ```

### Running pywerami
To start pysdb, simply type:

```bash
pysdb
```

Do not forget that virtual environment must be activated prior running `pysdb`.

## Getting help

If you get any errors [open a new Issue](https://github.com/ondrolexa/pysdb/issues) providing
the versions from either command above, as well as any errors you saw in the console during the installation.


## License

pysdb is free software: you can redistribute it and/or modify it under the terms of the MIT License.
A copy of this license is provided in ``LICENSE`` file.
