# PanpeApi

All URIs are relative to *http://localhost*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getAvailablePanpeModelsApiPanpeModelsGet**](#getavailablepanpemodelsapipanpemodelsget) | **GET** /api/panpe/models | Get Available Panpe Models|
|[**getPanpeParametersApiPanpeConfigNameParametersGet**](#getpanpeparametersapipanpeconfignameparametersget) | **GET** /api/panpe/{config_name}/parameters | Get Panpe Parameters|

# **getAvailablePanpeModelsApiPanpeModelsGet**
> Array<AvailableModel> getAvailablePanpeModelsApiPanpeModelsGet()

Get available PANPE models for reflectometry analysis.  Returns:     List[AvailableModel]: List of available PANPE models with their configurations      Raises:     HTTPException: If the configuration directory is not found

### Example

```typescript
import {
    PanpeApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new PanpeApi(configuration);

const { status, data } = await apiInstance.getAvailablePanpeModelsApiPanpeModelsGet();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<AvailableModel>**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getPanpeParametersApiPanpeConfigNameParametersGet**
> ReflectometryModelParameters getPanpeParametersApiPanpeConfigNameParametersGet()

Get parameters for a specific PANPE model configuration (like Reflectorch).  Args:     config_name (str): Name of the PANPE config (e.g., \'panpe-2layers-xrr\')      Returns:     ReflectometryModelParameters: Parameters for the model      Raises:     HTTPException: If the config is not found or cannot be parsed

### Example

```typescript
import {
    PanpeApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new PanpeApi(configuration);

let configName: string; // (default to undefined)

const { status, data } = await apiInstance.getPanpeParametersApiPanpeConfigNameParametersGet(
    configName
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **configName** | [**string**] |  | defaults to undefined|


### Return type

**ReflectometryModelParameters**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

