[](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
```
Alternatively, you can install it from a local wheel file:
```bash
pip install ./eseas-0.1.0-py3-none-any.whl
```
### jwsacruncher
The `jwsacruncher` tool is required for this package to function. You can download the latest release of `jwsacruncher` from the [jdemetra releases](https://github.com/jdemetra/jwsacruncher/releases/tag/v2.2.4).
```bash
# Download jwsacruncher
cd jdemetra/jswacruncher
```
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'../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": "https://github.com/SermetPekin/eseas-repo",
"name": "eseas",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "seasonal adjustment, data processing, jwsacruncher, Demetra",
"author": "Sermet Pekin",
"author_email": "Sermet.Pekin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/33/50/21aac16833a47ee2cdf41d35b304ebd6ab588328964ae0fd2c1e0aec7139/eseas-0.1.9.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\n```\n\nAlternatively, you can install it from a local wheel file:\n\n```bash\npip install ./eseas-0.1.0-py3-none-any.whl\n```\n\n### jwsacruncher\n\nThe `jwsacruncher` tool is required for this package to function. You can download the latest release of `jwsacruncher` from the [jdemetra releases](https://github.com/jdemetra/jwsacruncher/releases/tag/v2.2.4).\n\n```bash\n# Download jwsacruncher\ncd jdemetra/jswacruncher\n```\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'../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\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\n",
"bugtrack_url": null,
"license": "EUPL-1.2",
"summary": "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.",
"version": "0.1.9",
"project_urls": {
"Documentation": "https://github.com/SermetPekin/eseas-repo#readme",
"Homepage": "https://github.com/SermetPekin/eseas-repo",
"Repository": "https://github.com/SermetPekin/eseas-repo"
},
"split_keywords": [
"seasonal adjustment",
" data processing",
" jwsacruncher",
" demetra"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "775c5bdfd073a820721f2356c9b2f86e39e96ba5a924e9c7338203ab63eca35b",
"md5": "730e110402bfbeafecf4e1d4502348f5",
"sha256": "3e63b37eaacad14ea457c2396b4a2fcd1668a9603e5de0ad3ec0fe0ff5b469bd"
},
"downloads": -1,
"filename": "eseas-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "730e110402bfbeafecf4e1d4502348f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 39512,
"upload_time": "2024-06-14T07:32:53",
"upload_time_iso_8601": "2024-06-14T07:32:53.645146Z",
"url": "https://files.pythonhosted.org/packages/77/5c/5bdfd073a820721f2356c9b2f86e39e96ba5a924e9c7338203ab63eca35b/eseas-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "335021aac16833a47ee2cdf41d35b304ebd6ab588328964ae0fd2c1e0aec7139",
"md5": "24e0d6e62642b635e0da67209f173f09",
"sha256": "49d52dc10460b9bed24a557ae2a269c2d09dc04410e7c5b4980c39434613ad7f"
},
"downloads": -1,
"filename": "eseas-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "24e0d6e62642b635e0da67209f173f09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 27131,
"upload_time": "2024-06-14T07:32:55",
"upload_time_iso_8601": "2024-06-14T07:32:55.455090Z",
"url": "https://files.pythonhosted.org/packages/33/50/21aac16833a47ee2cdf41d35b304ebd6ab588328964ae0fd2c1e0aec7139/eseas-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-14 07:32:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SermetPekin",
"github_project": "eseas-repo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "eseas"
}
JSON
