[](https://github.com/SermetPekin/eseas-repo/actions/workflows/python-package.yml)
[](https://img.shields.io/pypi/v/eseas?1)
[](https://pypi.org/project/eseas/)
[](https://pepy.tech/project/eseas?1)
[](https://pepy.tech/project/eseas?1)
[](https://pepy.tech/project/eseas?1)
# eseas
eseas is a Python package that acts as a wrapper for the `jwsacruncher` Java package. This tool allows users to process Demetra workspace XML files, create batch files, execute them, and collect the desired outputs into individual Excel files.
## Installation
### eseas
You can install the `eseas` package via pip:
```bash
pip install eseas -U
```
## Prerequisites
### jwsacruncher
`eseas` requires the `jwsacruncher` Java package. You can download it
from the [jwsacruncher GitHub releases page](https://github.com/jdemetra/jwsacruncher/releases).
### Setup Instructions
1. Download the latest release of `jwsacruncher` from the [releases page](https://github.com/jdemetra/jwsacruncher/releases).
2. Unzip the downloaded file.
3. Note the path to the `bin` directory inside the unzipped folder.
After downloading `jwsacruncher`, you need to specify its location when using the `Options` function from the `eseas` package.
## Usage
Here's an example of how to use the `eseas` package:
```python
from eseas import Seasonal, Options
import time
def main():
# Specify the path to the jwsacruncher bin directory
java_folder = r'../../Downloads/jwsacruncher-2.2.4/bin'
demetra_source_folder = r"./demetra_source_folder"
local_folder = r"./test_out"
options = Options(
demetra_source_folder,
java_folder,
local_folder,
result_file_names=("sa", "s_f", "cal"), # *1
workspace_mode=True,
file_name_explanation=True,
)
# Note (1)
# result_file_names see full list of result types from Demetra Components below
seas = Seasonal(options)
seas.part1()
time.sleep(10)
seas.part2()
if __name__ == "__main__":
main()
```
## Documentation
For more detailed information, refer to the following guides:
- [Demetra Components](https://github.com/SermetPekin/eseas-repo/blob/main/docs/demetra_components.md)
- [Usage Guide](https://github.com/SermetPekin/eseas-repo/blob/main/docs/usage.md)
## How it Works
1. **Input Directory**: The user specifies the directory of the Demetra workspace where XML files are located.
2. **Batch File Creation**: The package creates batch files for all XML files in the specified directory.
3. **Execution**: It runs the batch files using the `jwsacruncher` tool.
4. **Output Collection**: The specified outputs are collected and compiled into individual Excel files for each XML file processed.
## Acknowledgments
Special thanks to the creators of the `jwsacruncher` Java package, which is integral to the functionality of `eseas`. For more information, visit the [jwsacruncher GitHub repository](https://github.com/jdemetra/jwsacruncher).
## About jwsacruncher
`jwsacruncher` is a Java implementation of the .NET application "WSACruncher". It is a console tool that re-estimates all the multi-processing defined in a workspace. The workspace can be generated by Demetra+ (.NET), JDemetra+ (Java), or any user tool. For more information, visit the [jwsacruncher GitHub repository](https://github.com/jdemetra/jwsacruncher).
## License
This project is licensed under the EUPL-1.2 License - see the [LICENSE](https://github.com/SermetPekin/eseas-repo/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "eseas",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Demetra, data processing, jwsacruncher, seasonal adjustment",
"author": null,
"author_email": "Sermet Pekin <Sermet.Pekin@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e4/71/66977438e753c958e3c1547def8d2c08c49b9781f116906a37b0ac8931b2/eseas-0.1.10.tar.gz",
"platform": null,
"description": "[](https://github.com/SermetPekin/eseas-repo/actions/workflows/python-package.yml)\n\n\n[](https://img.shields.io/pypi/v/eseas?1)\n[](https://pypi.org/project/eseas/)\n[](https://pepy.tech/project/eseas?1)\n[](https://pepy.tech/project/eseas?1)\n[](https://pepy.tech/project/eseas?1)\n\n\n\n# eseas\n\neseas is a Python package that acts as a wrapper for the `jwsacruncher` Java package. This tool allows users to process Demetra workspace XML files, create batch files, execute them, and collect the desired outputs into individual Excel files.\n\n## Installation\n\n### eseas\n\nYou can install the `eseas` package via pip:\n\n```bash\npip install eseas -U\n```\n\n \n## Prerequisites\n\n### jwsacruncher\n\n`eseas` requires the `jwsacruncher` Java package. You can download it\nfrom the [jwsacruncher GitHub releases page](https://github.com/jdemetra/jwsacruncher/releases).\n\n### Setup Instructions\n\n1. Download the latest release of `jwsacruncher` from the [releases page](https://github.com/jdemetra/jwsacruncher/releases).\n2. Unzip the downloaded file.\n3. Note the path to the `bin` directory inside the unzipped folder.\n\nAfter downloading `jwsacruncher`, you need to specify its location when using the `Options` function from the `eseas` package.\n\n## Usage\n\nHere's an example of how to use the `eseas` package:\n\n```python\nfrom eseas import Seasonal, Options\nimport time\n\ndef main():\n # Specify the path to the jwsacruncher bin directory\n java_folder = r'../../Downloads/jwsacruncher-2.2.4/bin'\n demetra_source_folder = r\"./demetra_source_folder\"\n local_folder = r\"./test_out\"\n\n options = Options(\n demetra_source_folder,\n java_folder,\n local_folder,\n result_file_names=(\"sa\", \"s_f\", \"cal\"), # *1\n workspace_mode=True,\n file_name_explanation=True,\n )\n # Note (1)\n # result_file_names see full list of result types from Demetra Components below\n\n seas = Seasonal(options)\n\n seas.part1()\n time.sleep(10)\n seas.part2()\n\nif __name__ == \"__main__\":\n main()\n```\n\n## Documentation\n\nFor more detailed information, refer to the following guides:\n\n- [Demetra Components](https://github.com/SermetPekin/eseas-repo/blob/main/docs/demetra_components.md)\n- [Usage Guide](https://github.com/SermetPekin/eseas-repo/blob/main/docs/usage.md)\n\n## How it Works\n\n1. **Input Directory**: The user specifies the directory of the Demetra workspace where XML files are located.\n2. **Batch File Creation**: The package creates batch files for all XML files in the specified directory.\n3. **Execution**: It runs the batch files using the `jwsacruncher` tool.\n4. **Output Collection**: The specified outputs are collected and compiled into individual Excel files for each XML file processed.\n\n## Acknowledgments\n\nSpecial thanks to the creators of the `jwsacruncher` Java package, which is integral to the functionality of `eseas`. For more information, visit the [jwsacruncher GitHub repository](https://github.com/jdemetra/jwsacruncher).\n\n## About jwsacruncher\n\n`jwsacruncher` is a Java implementation of the .NET application \"WSACruncher\". It is a console tool that re-estimates all the multi-processing defined in a workspace. The workspace can be generated by Demetra+ (.NET), JDemetra+ (Java), or any user tool. For more information, visit the [jwsacruncher GitHub repository](https://github.com/jdemetra/jwsacruncher).\n\n## License\n\nThis project is licensed under the EUPL-1.2 License - see the [LICENSE](https://github.com/SermetPekin/eseas-repo/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "EUPL-1.2",
"summary": "ESEAS is a Python package that serves as a wrapper for the jwsacruncher Java package. This tool allows users to process Demetra workspace XML files, create batch files, execute them, and collect the desired outputs into individual Excel files.",
"version": "0.1.10",
"project_urls": {
"documentation": "https://github.com/SermetPekin/eseas-repo#readme",
"repository": "https://github.com/SermetPekin/eseas-repo"
},
"split_keywords": [
"demetra",
" data processing",
" jwsacruncher",
" seasonal adjustment"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b2178c52bfe1839b6b1d3f2960eea68cc27e694e799ef7eebc418b28d37fa280",
"md5": "7a50583f345260f86c338e32a12327f0",
"sha256": "7711caf1b3e33b3153c5805f54331adf4cc60b4fcf7d41d3e878187d34fba2f5"
},
"downloads": -1,
"filename": "eseas-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a50583f345260f86c338e32a12327f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 40246,
"upload_time": "2025-02-12T08:15:59",
"upload_time_iso_8601": "2025-02-12T08:15:59.990529Z",
"url": "https://files.pythonhosted.org/packages/b2/17/8c52bfe1839b6b1d3f2960eea68cc27e694e799ef7eebc418b28d37fa280/eseas-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e47166977438e753c958e3c1547def8d2c08c49b9781f116906a37b0ac8931b2",
"md5": "c244eb25f031bf47a6a273fcdb9f5147",
"sha256": "e800afab80e6750ac6e38c42a114311eda72eccb66bb13c02020f0ed6a944460"
},
"downloads": -1,
"filename": "eseas-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "c244eb25f031bf47a6a273fcdb9f5147",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 29089,
"upload_time": "2025-02-12T08:16:02",
"upload_time_iso_8601": "2025-02-12T08:16:02.076708Z",
"url": "https://files.pythonhosted.org/packages/e4/71/66977438e753c958e3c1547def8d2c08c49b9781f116906a37b0ac8931b2/eseas-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 08:16:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SermetPekin",
"github_project": "eseas-repo#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "certifi",
"specs": [
[
"==",
"2024.6.2"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "commonmark",
"specs": [
[
"==",
"0.9.1"
]
]
},
{
"name": "et-xmlfile",
"specs": [
[
"==",
"1.1.0"
]
]
},
{
"name": "evdspy",
"specs": [
[
"==",
"1.1.25"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "iniconfig",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"1.26.4"
]
]
},
{
"name": "openpyxl",
"specs": [
[
"==",
"3.1.3"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.1"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"1.5.3"
]
]
},
{
"name": "pluggy",
"specs": [
[
"==",
"1.5.0"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"7.4.4"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.9.0.post0"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2024.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"12.6.0"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.2"
]
]
}
],
"lcname": "eseas"
}
JSON
