chore(deps): add dependencies inside pyproject + rename package for u…

…sers (#39)

docs/quickstart.md

@@ -4,7 +4,6 @@ To start using Antares Craft create a study using either the API or local modes,
 
 Exemple:
 
-    study = create_study_local("test_study", 880, {"local_path": "test_study", "study_name": "test_study"})
-
+    from antares.craft.model.study import create_study_local
 
-::: src.antares.model.study
+    study = create_study_local("test_study", 880, {"local_path": "test_study", "study_name": "test_study"})

pyproject.toml

@@ -16,7 +16,11 @@ authors = [
 ]
 requires-python = ">=3.9"
 dependencies = [
-
+    "configparser~=5.0.2",
+    "numpy~=1.26.4",
+    "pandas~=2.2.2",
+    "pydantic~=2.7.1",
+    "requests~=2.32.0"
 ]
 classifiers = [
 #    Classifiers here: https://pypi.org/classifiers/

src/antares/__init__.py → src/antares/craft/__init__.py

@@ -10,6 +10,6 @@
 #
 # This file is part of the Antares project.
 
-from antares.model.study import create_study_api, create_study_local
+from antares.craft.model.study import create_study_api, create_study_local
 
 __all__ = ["create_study_api", "create_study_local"]

src/antares/api_conf/api_conf.py → src/antares/craft/api_conf/api_conf.py

@@ -12,8 +12,8 @@
 
 import requests
 
-from antares.config.base_configuration import BaseConfiguration
-from antares.exceptions.exceptions import MissingTokenError
+from antares.craft.config.base_configuration import BaseConfiguration
+from antares.craft.exceptions.exceptions import MissingTokenError
 
 
 class APIconf(BaseConfiguration):

src/antares/api_conf/request_wrapper.py → src/antares/craft/api_conf/request_wrapper.py

@@ -16,7 +16,7 @@
 
 import requests
 
-from antares.exceptions.exceptions import APIError
+from antares.craft.exceptions.exceptions import APIError
 
 DATA_TYPE = Union[
     Iterable[bytes],

src/antares/config/local_configuration.py → src/antares/craft/config/local_configuration.py

@@ -12,7 +12,7 @@
 
 from pathlib import Path
 
-from antares.config.base_configuration import BaseConfiguration
+from antares.craft.config.base_configuration import BaseConfiguration
 
 
 class LocalConfiguration(BaseConfiguration):

src/antares/model/area.py → src/antares/craft/model/area.py

@@ -21,18 +21,17 @@
 
 import pandas as pd
 
+from antares.craft.model.commons import FilterOption, sort_filter_values
+from antares.craft.model.hydro import Hydro, HydroMatrixName, HydroProperties
+from antares.craft.model.renewable import RenewableCluster, RenewableClusterProperties
+from antares.craft.model.st_storage import STStorage, STStorageProperties
+from antares.craft.model.thermal import ThermalCluster, ThermalClusterProperties
+from antares.craft.tools.alias_generators import to_space
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.contents_tool import EnumIgnoreCase, transform_name_to_id
 from pydantic import BaseModel, computed_field
 from pydantic.alias_generators import to_camel
 
-from antares.model.commons import FilterOption, sort_filter_values
-from antares.model.hydro import Hydro, HydroMatrixName, HydroProperties
-from antares.model.renewable import RenewableCluster, RenewableClusterProperties
-from antares.model.st_storage import STStorage, STStorageProperties
-from antares.model.thermal import ThermalCluster, ThermalClusterProperties
-from antares.tools.alias_generators import to_space
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.contents_tool import EnumIgnoreCase, transform_name_to_id
-
 
 class AdequacyPatchMode(EnumIgnoreCase):
     """

src/antares/model/binding_constraint.py → src/antares/craft/model/binding_constraint.py

@@ -15,12 +15,11 @@
 
 import pandas as pd
 
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.contents_tool import EnumIgnoreCase, transform_name_to_id
 from pydantic import BaseModel, Field, model_validator
 from pydantic.alias_generators import to_camel
 
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.contents_tool import EnumIgnoreCase, transform_name_to_id
-
 
 class BindingConstraintFrequency(EnumIgnoreCase):
     HOURLY = "hourly"

src/antares/model/hydro.py → src/antares/craft/model/hydro.py

@@ -15,11 +15,10 @@
 
 import pandas as pd
 
+from antares.craft.tools.all_optional_meta import all_optional_model
 from pydantic import BaseModel
 from pydantic.alias_generators import to_camel
 
-from antares.tools.all_optional_meta import all_optional_model
-
 
 class HydroMatrixName(Enum):
     SERIES_ROR = "ror"

src/antares/model/link.py → src/antares/craft/model/link.py

@@ -15,13 +15,12 @@
 
 import pandas as pd
 
+from antares.craft.model.commons import FilterOption, sort_filter_values
+from antares.craft.tools.alias_generators import to_kebab
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.contents_tool import transform_name_to_id
 from pydantic import BaseModel
 
-from antares.model.commons import FilterOption, sort_filter_values
-from antares.tools.alias_generators import to_kebab
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.contents_tool import transform_name_to_id
-
 
 class TransmissionCapacities(Enum):
     ENABLED = "enabled"

src/antares/model/renewable.py → src/antares/craft/model/renewable.py

@@ -15,9 +15,9 @@
 
 import pandas as pd
 
-from antares.model.cluster import ClusterProperties
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.contents_tool import transform_name_to_id
+from antares.craft.model.cluster import ClusterProperties
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.contents_tool import transform_name_to_id
 
 
 class RenewableClusterGroup(Enum):

src/antares/model/settings/adequacy_patch.py → src/antares/craft/model/settings/adequacy_patch.py

@@ -12,11 +12,10 @@
 
 from enum import Enum
 
+from antares.craft.tools.all_optional_meta import all_optional_model
 from pydantic import BaseModel, ConfigDict, Field
 from pydantic.alias_generators import to_camel
 
-from antares.tools.all_optional_meta import all_optional_model
-
 
 class PriceTakingOrder(Enum):
     DENS = "DENS"

src/antares/model/settings/advanced_parameters.py → src/antares/craft/model/settings/advanced_parameters.py

@@ -13,14 +13,13 @@
 from enum import Enum
 from typing import Any, Optional
 
+from antares.craft.model.settings.general import OutputChoices
+from antares.craft.tools.alias_generators import to_kebab
+from antares.craft.tools.all_optional_meta import all_optional_model
 from pydantic import BaseModel, ConfigDict, Field, model_validator
 from pydantic.alias_generators import to_camel
 from typing_extensions import Self
 
-from antares.model.settings.general import OutputChoices
-from antares.tools.alias_generators import to_kebab
-from antares.tools.all_optional_meta import all_optional_model
-
 
 class InitialReservoirLevel(Enum):
     COLD_START = "cold start"

src/antares/model/settings/general.py → src/antares/craft/model/settings/general.py

@@ -10,12 +10,11 @@
 #
 # This file is part of the Antares project.
 
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.contents_tool import EnumIgnoreCase
 from pydantic import BaseModel, ConfigDict, Field
 from pydantic.alias_generators import to_camel
 
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.contents_tool import EnumIgnoreCase
-
 
 class Mode(EnumIgnoreCase):
     ECONOMY = "economy"

src/antares/model/settings/optimization.py → src/antares/craft/model/settings/optimization.py

@@ -13,11 +13,10 @@
 from enum import Enum
 from typing import Union
 
+from antares.craft.tools.all_optional_meta import all_optional_model
 from pydantic import BaseModel, ConfigDict, Field
 from pydantic.alias_generators import to_camel
 
-from antares.tools.all_optional_meta import all_optional_model
-
 
 class LegacyTransmissionCapacities(Enum):
     INFINITE = "infinite"

src/antares/model/settings/study_settings.py → src/antares/craft/model/settings/study_settings.py

@@ -11,18 +11,20 @@
 # This file is part of the Antares project.
 from typing import Optional
 
+from antares.craft.model.settings.adequacy_patch import AdequacyPatchParametersLocal, DefaultAdequacyPatchParameters
+from antares.craft.model.settings.advanced_parameters import AdvancedParametersLocal, DefaultAdvancedParameters
+from antares.craft.model.settings.general import DefaultGeneralParameters, GeneralParametersLocal
+from antares.craft.model.settings.optimization import DefaultOptimizationParameters, OptimizationParametersLocal
+from antares.craft.model.settings.playlist_parameters import PlaylistParameters
+from antares.craft.model.settings.thematic_trimming import (
+    DefaultThematicTrimmingParameters,
+    ThematicTrimmingParametersLocal,
+)
+from antares.craft.model.settings.time_series import DefaultTimeSeriesParameters, TimeSeriesParametersLocal
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.ini_tool import get_ini_fields_for_ini
 from pydantic import BaseModel, model_serializer
 
-from antares.model.settings.adequacy_patch import AdequacyPatchParametersLocal, DefaultAdequacyPatchParameters
-from antares.model.settings.advanced_parameters import AdvancedParametersLocal, DefaultAdvancedParameters
-from antares.model.settings.general import DefaultGeneralParameters, GeneralParametersLocal
-from antares.model.settings.optimization import DefaultOptimizationParameters, OptimizationParametersLocal
-from antares.model.settings.playlist_parameters import PlaylistParameters
-from antares.model.settings.thematic_trimming import DefaultThematicTrimmingParameters, ThematicTrimmingParametersLocal
-from antares.model.settings.time_series import DefaultTimeSeriesParameters, TimeSeriesParametersLocal
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.ini_tool import get_ini_fields_for_ini
-
 
 class DefaultStudySettings(BaseModel):
     general_parameters: DefaultGeneralParameters = DefaultGeneralParameters()

src/antares/model/settings/thematic_trimming.py → src/antares/craft/model/settings/thematic_trimming.py

@@ -11,11 +11,10 @@
 # This file is part of the Antares project.
 from enum import Enum
 
+from antares.craft.tools.all_optional_meta import all_optional_model
 from pydantic import BaseModel
 from pydantic.alias_generators import to_camel
 
-from antares.tools.all_optional_meta import all_optional_model
-
 
 class DefaultThematicTrimmingParameters(BaseModel, alias_generator=to_camel):
     """

src/antares/model/settings/time_series.py → src/antares/craft/model/settings/time_series.py

@@ -13,12 +13,11 @@
 from enum import Enum
 from typing import Optional
 
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.model_tools import filter_out_empty_model_fields
 from pydantic import BaseModel, Field
 from pydantic.alias_generators import to_camel
 
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.model_tools import filter_out_empty_model_fields
-
 
 class SeasonCorrelation(Enum):
     MONTHLY = "monthly"

src/antares/model/st_storage.py → src/antares/craft/model/st_storage.py

@@ -15,12 +15,11 @@
 
 import pandas as pd
 
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.contents_tool import transform_name_to_id
 from pydantic import BaseModel
 from pydantic.alias_generators import to_camel
 
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.contents_tool import transform_name_to_id
-
 
 class STStorageGroup(Enum):
     # todo: this class should disappear with Simulator version 9.1

src/antares/model/study.py → src/antares/craft/model/study.py

@@ -20,21 +20,21 @@
 
 import pandas as pd
 
-from antares.api_conf.api_conf import APIconf
-from antares.api_conf.request_wrapper import RequestWrapper
-from antares.config.local_configuration import LocalConfiguration
-from antares.exceptions.exceptions import APIError, LinkCreationError, StudyCreationError
-from antares.model.area import Area, AreaProperties, AreaUi
-from antares.model.binding_constraint import BindingConstraint, BindingConstraintProperties, ConstraintTerm
-from antares.model.link import Link, LinkProperties, LinkUi
-from antares.model.output import Output
-from antares.model.settings.study_settings import DefaultStudySettings, StudySettings, StudySettingsLocal
-from antares.model.settings.time_series import correlation_defaults
-from antares.model.simulation import AntaresSimulationParameters, Job
-from antares.service.api_services.study_api import _returns_study_settings
-from antares.service.base_services import BaseStudyService
-from antares.service.service_factory import ServiceFactory
-from antares.tools.ini_tool import IniFile, IniFileTypes
+from antares.craft.api_conf.api_conf import APIconf
+from antares.craft.api_conf.request_wrapper import RequestWrapper
+from antares.craft.config.local_configuration import LocalConfiguration
+from antares.craft.exceptions.exceptions import APIError, LinkCreationError, StudyCreationError
+from antares.craft.model.area import Area, AreaProperties, AreaUi
+from antares.craft.model.binding_constraint import BindingConstraint, BindingConstraintProperties, ConstraintTerm
+from antares.craft.model.link import Link, LinkProperties, LinkUi
+from antares.craft.model.output import Output
+from antares.craft.model.settings.study_settings import DefaultStudySettings, StudySettings, StudySettingsLocal
+from antares.craft.model.settings.time_series import correlation_defaults
+from antares.craft.model.simulation import AntaresSimulationParameters, Job
+from antares.craft.service.api_services.study_api import _returns_study_settings
+from antares.craft.service.base_services import BaseStudyService
+from antares.craft.service.service_factory import ServiceFactory
+from antares.craft.tools.ini_tool import IniFile, IniFileTypes
 
 """
 The study module defines the data model for antares study.

src/antares/model/thermal.py → src/antares/craft/model/thermal.py

@@ -15,9 +15,9 @@
 
 import pandas as pd
 
-from antares.model.cluster import ClusterProperties
-from antares.tools.all_optional_meta import all_optional_model
-from antares.tools.contents_tool import transform_name_to_id
+from antares.craft.model.cluster import ClusterProperties
+from antares.craft.tools.all_optional_meta import all_optional_model
+from antares.craft.tools.contents_tool import transform_name_to_id
 
 
 class LawOption(Enum):

src/antares/service/api_services/area_api.py → src/antares/craft/service/api_services/area_api.py

@@ -14,9 +14,9 @@
 
 import pandas as pd
 
-from antares.api_conf.api_conf import APIconf
-from antares.api_conf.request_wrapper import RequestWrapper
-from antares.exceptions.exceptions import (
+from antares.craft.api_conf.api_conf import APIconf
+from antares.craft.api_conf.request_wrapper import RequestWrapper
+from antares.craft.exceptions.exceptions import (
     APIError,
     AreaCreationError,
     AreaDeletionError,
@@ -32,20 +32,20 @@
     ThermalCreationError,
     ThermalDeletionError,
 )
-from antares.model.area import Area, AreaProperties, AreaUi
-from antares.model.hydro import Hydro, HydroMatrixName, HydroProperties
-from antares.model.renewable import RenewableCluster, RenewableClusterProperties
-from antares.model.st_storage import STStorage, STStorageProperties
-from antares.model.thermal import ThermalCluster, ThermalClusterProperties
-from antares.service.api_services.utils import get_matrix, upload_series
-from antares.service.base_services import (
+from antares.craft.model.area import Area, AreaProperties, AreaUi
+from antares.craft.model.hydro import Hydro, HydroMatrixName, HydroProperties
+from antares.craft.model.renewable import RenewableCluster, RenewableClusterProperties
+from antares.craft.model.st_storage import STStorage, STStorageProperties
+from antares.craft.model.thermal import ThermalCluster, ThermalClusterProperties
+from antares.craft.service.api_services.utils import get_matrix, upload_series
+from antares.craft.service.base_services import (
     BaseAreaService,
     BaseRenewableService,
     BaseShortTermStorageService,
     BaseThermalService,
 )
-from antares.tools.contents_tool import AreaUiResponse
-from antares.tools.matrix_tool import prepare_args_replace_matrix
+from antares.craft.tools.contents_tool import AreaUiResponse
+from antares.craft.tools.matrix_tool import prepare_args_replace_matrix
 
 
 class AreaApiService(BaseAreaService):