Bump version to 0.1.4, update package description, and adjust Python version requirements in pyproject.toml and poetry.lock

Author: c0sogi

README.md

@@ -1,193 +1,144 @@
-# DCM
-
-A Python package for reading and writing DCM (Data Conservation Format) files used in various ECU calibration tools such as INCA, MDA, EHANDBOOK, CANape, and more.
-
-## Table of Contents
-
-- [Features](#features)
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Reading a DCM File](#reading-a-dcm-file)
-  - [Writing a DCM File](#writing-a-dcm-file)
-  - [Accessing Data](#accessing-data)
-  - [Loading Data from Excel](#loading-data-from-excel)
-  - [Interpolation Functions](#interpolation-functions)
-- [Examples](#examples)
-- [Dependencies](#dependencies)
-- [License](#license)
-- [Contributing](#contributing)
-- [Contact](#contact)
-
-## Features
-
-- **Read and Write DCM Files**: Parse and generate DCM files used in ECU calibration.
-- **Data Manipulation**: Access and modify parameters, curves, maps, and other calibration data.
-- **Excel Integration**: Load calibration data from Excel files.
-- **Interpolation**: Perform 1D and 2D linear interpolation on calibration data.
-- **Visualization**: Plot characteristic lines and maps using Matplotlib.
-- **Support for Various Data Types**: Handle parameters, parameter blocks, characteristic lines, characteristic maps, distributions, and text strings.
+Let me revise it with a more user-friendly approach in English:
 
-## Installation
-
-Ensure you have Python 3.11 or higher installed. Install the package using `pip`:
-
-```bash
-pip install git+https://github.com/c0sogi/python-dcm.git
-```
+# python-dcm
 
-Or if you have the package files locally:
+A high-performance Python package for handling ETAS DCM(Data Conversion Format) files used in engine calibration tools like INCA, MDA, EHANDBOOK, and CANape.
 
-```bash
-pip install .
-```
-
-## Usage
-
-### Reading a DCM File
+## Quick Start
 
 ```python
 from dcm import DCM
 
 # Read a DCM file
-dcm = DCM.from_file('path/to/your_file.dcm')
-```
+dcm = DCM.from_file('calibration.dcm')
 
-### Writing a DCM File
+# Access calibration data
+parameter_value = dcm.parameters['ENGINE_SPEED'].value
+map_data = dcm.maps['FUEL_MAP'].dataframe
+curve_data = dcm.curves['BOOST_CURVE'].series
 
-```python
-# Write the DCM object to a file
-dcm.write('path/to/output_file.dcm')
-```
-
-### Accessing Data
-
-```python
-# Access a parameter
-parameter = dcm.parameters['PARAMETER_NAME']
-print(parameter.value)
+# Interpolate values
+x_points = [1000, 1500, 2000]  # RPM
+y_points = [50, 75, 100]       # Load %
+interpolated = dcm.maps['FUEL_MAP'].as_function(x_points, y_points)
 
-# Access a characteristic line (curve)
-curve = dcm.curves['CURVE_NAME']
-print(curve.series)
-
-# Access a characteristic map
-char_map = dcm.maps['MAP_NAME']
-print(char_map.dataframe)
+# Visualize data
+dcm.maps['FUEL_MAP'].to_figure()
 ```
 
-### Loading Data from Excel
-
-You can load calibration data from Excel files into the DCM object.
+## Key Features
 
-```python
-# Load maps from an Excel file
-dcm.load_maps('maps.xlsx')
+- **Easy Data Access**: Directly access parameters, curves, and maps with Pandas integration
+- **Interpolation**: Built-in 1D/2D linear interpolation for real-time value calculation
+- **Visualization**: One-line plotting of characteristic curves and maps
+- **Excel Integration**: Import/export calibration data from Excel spreadsheets
+- **Set Operations**: Compare and merge DCM files with `|`, `-`, `&`, and `%` operators
+- **Type Support**: Handle all DCM data types including fixed/group characteristics
 
-# Load curves from an Excel file
-dcm.load_lines('curves.xlsx')
+## Installation
 
-# Load parameters from an Excel file
-dcm.load_parameters('parameters.xlsx')
+Requires Python ≥ 3.10
 
-# Load parameter blocks from an Excel file
-dcm.load_parameter_blocks('parameter_blocks.xlsx')
+```bash
+pip install python-dcm
 ```
 
-### Interpolation Functions
-
-Perform interpolation using the calibration data.
-
-#### 1D Interpolation (Characteristic Line)
+## Common Use Cases
 
+### Data Access & Manipulation
 ```python
-# Get the interpolation function for a curve
-curve_function = curve.as_function
+# Get parameter value
+rpm_limit = dcm.parameters['MAX_RPM'].value
 
-# Interpolate at specific points
-import numpy as np
-x_values = np.array([1.0, 2.0, 3.0])
-interpolated_values = curve_function(x_values)
-```
+# Access map as DataFrame
+fuel_map = dcm.maps['FUEL_MAP'].dataframe
+fuel_map.iloc[0, 0] = 14.7  # Modify value
 
-#### 2D Interpolation (Characteristic Map)
+# Get curve data
+boost_curve = dcm.curves['BOOST_CURVE'].series
+max_boost = boost_curve.max()
+```
 
+### Excel Integration
 ```python
-# Get the interpolation function for a map
-map_function = char_map.as_function
-
-# Interpolate at specific x and y points
-x_values = np.array([1.0, 2.0, 3.0])
-y_values = np.array([4.0, 5.0, 6.0])
-interpolated_values = map_function(x_values, y_values)
+# Load calibration data from Excel
+dcm.load_from_excel(
+    maps_path='maps.xlsx',
+    curves_path='curves.xlsx',
+    parameters_path='params.xlsx'
+)
+
+# Each sheet name becomes the calibration object name
 ```
 
-## Examples
-
-### Plotting a Characteristic Line
-
+### Visualization
 ```python
 import matplotlib.pyplot as plt
 
-# Plot the curve
-fig, ax = curve.to_figure()
+# Plot a map with custom settings
+fig, ax = dcm.maps['FUEL_MAP'].to_figure(
+    cmap='viridis',
+    fontsize=12
+)
 plt.show()
+
+# Plot multiple curves
+fig, ax = plt.subplots()
+dcm.curves['BOOST_LOW'].to_figure(ax=ax, label='Low')
+dcm.curves['BOOST_HIGH'].to_figure(ax=ax, label='High')
+plt.legend()
 ```
 
-### Plotting a Characteristic Map
+### Advanced Features
 
+#### Parameter Type Conversion
 ```python
-import matplotlib.pyplot as plt
-
-# Plot the map
-fig, ax = char_map.to_figure()
-plt.show()
+param = dcm.parameters['CONTROL_BITS']
+binary = param.as_bin()    # [1, 3, 5] (bits set to 1)
+hex_val = param.as_hex()   # [A, F, 1] (hexadecimal digits)
 ```
 
-### Combining DCM Objects
-
-You can combine DCM objects using set operations:
-
+#### DCM File Comparison
 ```python
-# Union of two DCM objects
-combined_dcm = dcm1 | dcm2
+# Find differences between calibrations
+modified = old_dcm % new_dcm
+print(modified.parameters.keys())  # Changed parameters
 
-# Difference between two DCM objects
-difference_dcm = dcm1 - dcm2
+# Merge calibrations
+combined = dcm1 | dcm2
+```
 
-# Intersection of two DCM objects
-intersection_dcm = dcm1 & dcm2
+## Supported Data Types
 
-# Modifications between two DCM objects
-modifications_dcm = dcm1 % dcm2
-```
+- Parameters (FESTWERT)
+- Parameter Blocks (FESTWERTEBLOCK)
+- Characteristic Lines (KENNLINIE/FESTKENNLINIE/GRUPPENKENNLINIE)
+- Characteristic Maps (KENNFELD/FESTKENNFELD/GRUPPENKENNFELD)
+- Distributions (STUETZSTELLENVERTEILUNG)
+- Text Strings (TEXTSTRING)
 
 ## Dependencies
 
-- Python >= 3.11
-- [NumPy](https://numpy.org/) >= 1.20.0
-- [Pandas](https://pandas.pydata.org/) >= 1.5.0
-- [Matplotlib](https://matplotlib.org/) >= 3.0.0
-- [OpenPyXL](https://openpyxl.readthedocs.io/en/stable/) >= 3.1.0
+- NumPy ≥ 1.20.0
+- Pandas ≥ 1.5.0
+- Matplotlib ≥ 3.0.0
+- OpenPyXL ≥ 3.1.0
 
 ## License
 
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+MIT License
 
 ## Contributing
 
-Contributions are welcome! Please follow these steps:
+Contributions welcome! Please format code with [ruff](https://docs.astral.sh/ruff/) before submitting PRs.
 
-1. Fork the repository.
-2. Create a new branch (`git checkout -b feature/YourFeature`).
-3. Commit your changes (`git commit -am 'Add new feature'`).
-4. Push to the branch (`git push origin feature/YourFeature`).
-5. Create a new Pull Request.
+## Contact
 
-Please ensure that your code adheres to the existing style and that all tests pass.
+- Author: c0sogi
+- Email: dcas@naver.com or cosogi1@gmail.com
 
-## Contact
+Feel free to reach out for questions or suggestions.
 
-Author: c0sogi  
-Email: [dcas@naver.com](mailto:dcas@naver.com) or [cosogi1@gmail.com](mailto:cosogi1@gmail.com)
+---
 
-Feel free to reach out for questions or discussions.
+For detailed documentation and examples, visit our [GitHub repository](https://github.com/c0sogi/python-dcm).