https://github.com/statisticsnorway/ssb-statstruk

Model estimation for business surveys.
https://github.com/statisticsnorway/ssb-statstruk

pypi ssb-project

Last synced: 4 months ago
JSON representation

Model estimation for business surveys.

• Host: GitHub
• URL: https://github.com/statisticsnorway/ssb-statstruk
• Owner: statisticsnorway
• License: mit
• Created: 2024-02-19T15:32:46.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-01T09:01:20.000Z (6 months ago)
• Last Synced: 2024-11-18T09:13:33.102Z (5 months ago)
• Topics: pypi, ssb-project
• Language: Python
• Homepage:
• Size: 967 KB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# SSB Statstruk

[![PyPI](https://img.shields.io/pypi/v/ssb-statstruk.svg)][pypi status]

[![Status](https://img.shields.io/pypi/status/ssb-statstruk.svg)][pypi status]

[![Python Version](https://img.shields.io/pypi/pyversions/ssb-statstruk)][pypi status]

[![License](https://img.shields.io/pypi/l/ssb-statstruk)][license]

[![Documentation](https://github.com/statisticsnorway/ssb-statstruk/actions/workflows/docs.yml/badge.svg)][documentation]

[![Tests](https://github.com/statisticsnorway/ssb-statstruk/actions/workflows/tests.yml/badge.svg)][tests]

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-statstruk&metric=coverage)][sonarcov]

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-statstruk&metric=alert_status)][sonarquality]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]

[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]

[pypi status]: https://pypi.org/project/ssb-statstruk/

[documentation]: https://statisticsnorway.github.io/ssb-statstruk

[tests]: https://github.com/statisticsnorway/ssb-statstruk/actions?workflow=Tests

[sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-statstruk

[sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-statstruk

[pre-commit]: https://github.com/pre-commit/pre-commit

[black]: https://github.com/psf/black

[poetry]: https://python-poetry.org/

![statstruk logo](https://github.com/statisticsnorway/ssb-statstruk/blob/main/docs/images/statstruk.png)

## Installation

You can install the _statstruk_ via [pip] from [PyPI]:

```console

pip install ssb-statstruk

```

## Usage

For examples on running a rate model see the [Quick guide to running a rate model with **_statstruk_**](https://statisticsnorway.github.io/ssb-statstruk/guide_rate.html). Further function references are given in the [Reference guide]. Theory used in the caluclations is described in the theory references for Homogenous models, [Rate models], and Regression models.

## Contributing

Contributions are very welcome.

To learn more, see the [Contributor guide](https://github.com/statisticsnorway/ssb-statstruk/blob/main/docs/contributing.md).

## License

Distributed under the terms of the [MIT license](https://github.com/statisticsnorway/ssb-statstruk/blob/main/license),

_SSB Statstruk_ is free and open source software.

## Issues

If you encounter any problems,

please [file an issue] along with a detailed description.

## Credits

This project was generated from [Statistics Norway]'s [SSB PyPI Template].

[statistics norway]: https://www.ssb.no/en

[pypi]: https://pypi.org/

[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate

[file an issue]: https://github.com/statisticsnorway/ssb-statstruk/issues

[pip]: https://pip.pypa.io/

[Reference guide]: https://statisticsnorway.github.io/ssb-statstruk/reference.html

[rate models]: https://statisticsnorway.github.io/ssb-statstruk/theory_rate.html

[license]: https://github.com/statisticsnorway/ssb-statstruk/blob/main/LICENSE

[Contributor guide]: https://github.com/statisticsnorway/ssb-statstruk/blob/main/docs/CONTRIBUTING.md

[reference guide]: https://statisticsnorway.github.io/ssb-statstruk/reference.html