Skip to main content

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.

Project description

Python package

PyPI Supported Python Versions Downloads Downloads Downloads

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:

pip install eseas

Alternatively, you can install it from a local wheel file:

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.

# 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:

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:

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.

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.

License

This project is licensed under the EUPL-1.2 License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eseas-0.1.7.tar.gz (32.1 kB view hashes)

Uploaded Source

Built Distribution

eseas-0.1.7-py3-none-any.whl (46.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page